gltf_materialx_converter.utilities Namespace Reference

Functions
	load_json_file (filename)
	Load a JSON file.
	load_standard_libraries ()
	Load standard MaierialX libraries.
	create_working_document (libraries)
	Create a working document and import any libraries.
	import_libraries (doc, libraries)
	Import libraries into a document.
	read_materialX_document (materialx_doc, input_file)
	Read a MaterialX document from a file.
	materialX_doc_to_string (materialx_doc)
	Convert a MaterialX document to a string.
	validate_document (doc)
	Validate a MaterialX document.
	get_files (rootPath, extension)
	Get all files with a given extension in a directory.
	have_version (major, minor, patch)
	Check if the current vesion matches a given version @parm major: The major version number @parm minor: The minor version number @parm patch: The patch version number.
	remove_comments (doc)
	Remove all comments from a MaterialX document.

Function Documentation

create_working_document()

gltf_materialx_converter.utilities.create_working_document

(

libraries

)

Create a working document and import any libraries.

Parameters

libraries

The list of definition libraries to import.

Returns

: The new working document

Definition at line 31 of file utilities.py.

def create_working_document(libraries):
    '''Create a working document and import any libraries
    @param libraries: The list of definition libraries to import.
    @return: The new working document
    '''
    doc = mx.createDocument()
    for lib in libraries:
        doc.importLibrary(lib)
 
    return doc
 

get_files()

gltf_materialx_converter.utilities.get_files	(		rootPath,
			extension )

Get all files with a given extension in a directory.

Parameters

rootPath	The root directory to search.
extension	The file extension to search for.

Returns

: The list of files with the given extension.

Definition at line 72 of file utilities.py.

def get_files(rootPath, extension):
    '''Get all files with a given extension in a directory.
    @param rootPath: The root directory to search.
    @param extension: The file extension to search for.
    @return: The list of files with the given extension.
    '''
    filelist = []
    exts = (extension)
    for subdir, dirs, files in os.walk(rootPath):
        for file in files:
            if file.lower().endswith(exts):
                filelist.append(os.path.join(subdir, file)) 
    return filelist
 

have_version()

gltf_materialx_converter.utilities.have_version	(		major,
			minor,
			patch )

Check if the current vesion matches a given version @parm major: The major version number @parm minor: The minor version number @parm patch: The patch version number.

Returns

: True if the current version is greater or equal to the given version

Definition at line 86 of file utilities.py.

def have_version(major, minor, patch):
    '''
    Check if the current vesion matches a given version
    @parm major: The major version number
    @parm minor: The minor version number
    @parm patch: The patch version number
    @return: True if the current version is greater or equal to the given version
    ''' 
    imajor, iminor, ipatch = mx.getVersionIntegers()
 
    if major >= imajor:
        if  major > imajor:
            return True        
        if iminor >= minor:
            if iminor > minor:
                return True 
            if  ipatch >= patch:
                return True
    return False
 

import_libraries()

gltf_materialx_converter.utilities.import_libraries	(		doc,
			libraries )

Import libraries into a document.

Parameters

doc	The document to import into.
libraries	The list of libraries to import.

Definition at line 42 of file utilities.py.

def import_libraries(doc, libraries):
    '''Import libraries into a document.
    @param doc: The document to import into.
    @param libraries: The list of libraries to import.
    '''
    doc.importLibrary(libraries)
 

load_json_file()

gltf_materialx_converter.utilities.load_json_file

(

filename

)

Load a JSON file.

Parameters

filename

The file to load.

Returns

: The JSON string

Definition at line 12 of file utilities.py.

def load_json_file(filename):
    '''Load a JSON file.
    @param filename: The file to load.
    @return: The JSON string
    '''
    json_string = ''
    with open(filename, 'r') as file:
        file = json.load(file)
        json_string = json.dumps(file, indent=2)
    return json_string    
 

load_standard_libraries()

gltf_materialx_converter.utilities.load_standard_libraries

(

)

Load standard MaierialX libraries.

Returns

: The standard library and the list of library files.

Definition at line 23 of file utilities.py.

def load_standard_libraries():
    '''Load standard MaierialX libraries.
    @return: The standard library and the list of library files.
    '''
    stdlib = mx.createDocument()
    libFiles = mx.loadLibraries(mx.getDefaultDataLibraryFolders(), mx.getDefaultDataSearchPath(), stdlib)
    return stdlib, libFiles
 

materialX_doc_to_string()

gltf_materialx_converter.utilities.materialX_doc_to_string

(

materialx_doc

)

Convert a MaterialX document to a string.

Parameters

materialx_doc

The document to convert.

Returns

: The document as a string.

Definition at line 57 of file utilities.py.

def materialX_doc_to_string(materialx_doc):
    '''Convert a MaterialX document to a string.
    @param materialx_doc: The document to convert.
    @return: The document as a string.
    '''
    return mx.writeToXmlString(materialx_doc)
 

read_materialX_document()

gltf_materialx_converter.utilities.read_materialX_document	(		materialx_doc,
			input_file )

Read a MaterialX document from a file.

Parameters

materialx_doc	The MaterialX document to read into.
input_file	The file to read from.

Definition at line 49 of file utilities.py.

def read_materialX_document(materialx_doc, input_file):
    '''
    Read a MaterialX document from a file.
    @param materialx_doc: The MaterialX document to read into.
    @param input_file: The file to read from.
    '''
    mx.readFromXmlFile(materialx_doc, input_file)
 

remove_comments()

gltf_materialx_converter.utilities.remove_comments

(

doc

)

Remove all comments from a MaterialX document.

Parameters

doc	The document to remove comments from.

Definition at line 106 of file utilities.py.

def remove_comments(doc):
    '''
    Remove all comments from a MaterialX document.
    @param doc: The document to remove comments from.
    '''
    comments = doc.getChildren()
    for comment in comments:
        if comment.getCategory() == 'comment':
            doc.removeChild(comment.getName())
 

validate_document()

gltf_materialx_converter.utilities.validate_document

(

doc

)

Validate a MaterialX document.

Parameters

doc	The document to validate.

Returns

: The validation result as a tuple of [valid, error string].

Definition at line 64 of file utilities.py.

def validate_document(doc):
    '''Validate a MaterialX document.
    @param doc: The document to validate.
    @return: The validation result as a tuple of [valid, error string].
    '''
    valid, error_string = doc.validate()
    return valid, error_string