Geom.h File Reference

#include <MaterialXCore/Export.h>
#include <MaterialXCore/Element.h>

Include dependency graph for Geom.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	GeomPath
class	GeomElement
class	GeomInfo
class	GeomProp
class	GeomPropDef
class	Collection

Typedefs
using	GeomElementPtr = shared_ptr< GeomElement >
	A shared pointer to a GeomElement. More...
using	ConstGeomElementPtr = shared_ptr< const GeomElement >
	A shared pointer to a const GeomElement. More...
using	GeomInfoPtr = shared_ptr< GeomInfo >
	A shared pointer to a GeomInfo. More...
using	ConstGeomInfoPtr = shared_ptr< const GeomInfo >
	A shared pointer to a const GeomInfo. More...
using	GeomPropPtr = shared_ptr< GeomProp >
	A shared pointer to a GeomProp. More...
using	ConstGeomPropPtr = shared_ptr< const GeomProp >
	A shared pointer to a const GeomProp. More...
using	GeomPropDefPtr = shared_ptr< GeomPropDef >
	A shared pointer to a GeomPropDef. More...
using	ConstGeomPropDefPtr = shared_ptr< const GeomPropDef >
	A shared pointer to a const GeomPropDef. More...
using	CollectionPtr = shared_ptr< Collection >
	A shared pointer to a Collection. More...
using	ConstCollectionPtr = shared_ptr< const Collection >
	A shared pointer to a const Collection. More...

Functions
MX_CORE_API bool	geomStringsMatch (const string &geom1, const string &geom2, bool contains=false)

Variables
MATERIALX_NAMESPACE_BEGIN MX_CORE_API const string	GEOM_PATH_SEPARATOR
MX_CORE_API const string	UNIVERSAL_GEOM_NAME
MX_CORE_API const string	UDIM_TOKEN
MX_CORE_API const string	UV_TILE_TOKEN
MX_CORE_API const string	UDIM_SET_PROPERTY

Detailed Description

Geometric element subclasses

Definition in file Geom.h.

Typedef Documentation

using CollectionPtr = shared_ptr<Collection>

A shared pointer to a Collection.

Definition at line 53 of file Geom.h.

using ConstCollectionPtr = shared_ptr<const Collection>

A shared pointer to a const Collection.

Definition at line 55 of file Geom.h.

using ConstGeomElementPtr = shared_ptr<const GeomElement>

A shared pointer to a const GeomElement.

Definition at line 35 of file Geom.h.

using ConstGeomInfoPtr = shared_ptr<const GeomInfo>

A shared pointer to a const GeomInfo.

Definition at line 40 of file Geom.h.

using ConstGeomPropDefPtr = shared_ptr<const GeomPropDef>

A shared pointer to a const GeomPropDef.

Definition at line 50 of file Geom.h.

using ConstGeomPropPtr = shared_ptr<const GeomProp>

A shared pointer to a const GeomProp.

Definition at line 45 of file Geom.h.

using GeomElementPtr = shared_ptr<GeomElement>

A shared pointer to a GeomElement.

Definition at line 33 of file Geom.h.

using GeomInfoPtr = shared_ptr<GeomInfo>

A shared pointer to a GeomInfo.

Definition at line 38 of file Geom.h.

using GeomPropDefPtr = shared_ptr<GeomPropDef>

A shared pointer to a GeomPropDef.

Definition at line 48 of file Geom.h.

using GeomPropPtr = shared_ptr<GeomProp>

A shared pointer to a GeomProp.

Definition at line 43 of file Geom.h.

Function Documentation

MX_CORE_API bool geomStringsMatch	(	const string &	geom1,
		const string &	geom2,
		bool	contains = false
	)

Given two geometry strings, each containing an array of geom names, return true if they have any geometries in common.

An empty geometry string matches no geometries, while the universal geometry string "/" matches all non-empty geometries.

If the contains argument is set to true, then we require that a geom path in the first string completely contains a geom path in the second string.

Todo:

Geometry name expressions are not yet supported.

Variable Documentation

MATERIALX_NAMESPACE_BEGIN MX_CORE_API const string GEOM_PATH_SEPARATOR

MX_CORE_API const string UDIM_SET_PROPERTY

MX_CORE_API const string UDIM_TOKEN

MX_CORE_API const string UNIVERSAL_GEOM_NAME

MX_CORE_API const string UV_TILE_TOKEN