#include <Geom.h>

Inheritance diagram for Collection:

Public Member Functions
	Collection (ElementPtr parent, const string &name)

virtual	~Collection ()

Include Geometry
void	setIncludeGeom (const string &geom)
	Set the include geometry string of this element. More...

bool	hasIncludeGeom () const
	Return true if this element has an include geometry string. More...

const string &	getIncludeGeom () const
	Return the include geometry string of this element. More...

string	getActiveIncludeGeom () const

Exclude Geometry
void	setExcludeGeom (const string &geom)
	Set the exclude geometry string of this element. More...

bool	hasExcludeGeom () const
	Return true if this element has an exclude geometry string. More...

const string &	getExcludeGeom () const
	Return the exclude geometry string of this element. More...

string	getActiveExcludeGeom () const

Include Collection
void	setIncludeCollectionString (const string &collection)
	Set the include collection string of this element. More...

bool	hasIncludeCollectionString () const
	Return true if this element has an include collection string. More...

const string &	getIncludeCollectionString () const
	Return the include collection string of this element. More...

void	setIncludeCollection (ConstCollectionPtr collection)
	Set the collection that is directly included by this element. More...

void	setIncludeCollections (const vector< ConstCollectionPtr > &collections)

vector< CollectionPtr >	getIncludeCollections () const

bool	hasIncludeCycle () const
	Return true if the include chain for this element contains a cycle. More...

Geometry Matching
bool	matchesGeomString (const string &geom) const

Validation
bool	validate (string *message=nullptr) const override

Public Member Functions inherited from Element
virtual	~Element ()

	Element (const Element &)=delete

Element &	operator= (const Element &)=delete

bool	operator== (const Element &rhs) const

bool	operator!= (const Element &rhs) const

void	setCategory (const string &category)
	Set the element's category string. More...

const string &	getCategory () const

void	setName (const string &name)

const string &	getName () const
	Return the element's name string. More...

string	getNamePath (ConstElementPtr relativeTo=nullptr) const

ElementPtr	getDescendant (const string &namePath) const

void	setFilePrefix (const string &prefix)
	Set the element's file prefix string. More...

bool	hasFilePrefix () const
	Return true if the given element has a file prefix string. More...

const string &	getFilePrefix () const
	Return the element's file prefix string. More...

const string &	getActiveFilePrefix () const

void	setGeomPrefix (const string &prefix)
	Set the element's geom prefix string. More...

bool	hasGeomPrefix () const
	Return true if the given element has a geom prefix string. More...

const string &	getGeomPrefix () const
	Return the element's geom prefix string. More...

const string &	getActiveGeomPrefix () const

void	setColorSpace (const string &colorSpace)
	Set the element's color space string. More...

bool	hasColorSpace () const
	Return true if the given element has a color space string. More...

const string &	getColorSpace () const
	Return the element's color space string. More...

const string &	getActiveColorSpace () const

void	setInheritString (const string &inherit)
	Set the inherit string of this element. More...

bool	hasInheritString () const
	Return true if this element has an inherit string. More...

const string &	getInheritString () const
	Return the inherit string of this element. More...

void	setInheritsFrom (ConstElementPtr super)
	Set the element that this one directly inherits from. More...

ElementPtr	getInheritsFrom () const
	Return the element, if any, that this one directly inherits from. More...

bool	hasInheritedBase (ConstElementPtr base) const

bool	hasInheritanceCycle () const
	Return true if the inheritance chain for this element contains a cycle. More...

void	setNamespace (const string &space)
	Set the namespace string of this element. More...

bool	hasNamespace () const
	Return true if this element has a namespace string. More...

const string &	getNamespace () const
	Return the namespace string of this element. More...

string	getQualifiedName (const string &name) const

void	setDocString (const string &doc)
	Set the documentation string of this element. More...

string	getDocString () const
	Return the documentation string of this element. More...

template<class T >
bool	isA (const string &category=EMPTY_STRING) const

template<class T >
shared_ptr< T >	asA ()
	Dynamic cast to an instance of the given subclass. More...

template<class T >
shared_ptr< const T >	asA () const
	Dynamic cast to a const instance of the given subclass. More...

template<class T >
shared_ptr< T >	addChild (const string &name=EMPTY_STRING)

ElementPtr	addChildOfCategory (const string &category, string name=EMPTY_STRING)

ElementPtr	changeChildCategory (ElementPtr child, const string &category)

ElementPtr	getChild (const string &name) const
	Return the child element, if any, with the given name. More...

template<class T >
shared_ptr< T >	getChildOfType (const string &name) const

const vector< ElementPtr > &	getChildren () const

template<class T >
vector< shared_ptr< T > >	getChildrenOfType (const string &category=EMPTY_STRING) const

void	setChildIndex (const string &name, int index)

int	getChildIndex (const string &name) const

void	removeChild (const string &name)
	Remove the child element, if any, with the given name. More...

template<class T >
void	removeChildOfType (const string &name)

void	setAttribute (const string &attrib, const string &value)
	Set the value string of the given attribute. More...

bool	hasAttribute (const string &attrib) const
	Return true if the given attribute is present. More...

const string &	getAttribute (const string &attrib) const

const StringVec &	getAttributeNames () const
	Return a vector of stored attribute names, in the order they were set. More...

template<class T >
void	setTypedAttribute (const string &attrib, const T &data)

template<class T >
T	getTypedAttribute (const string &attrib) const

void	removeAttribute (const string &attrib)
	Remove the given attribute, if present. More...

ElementPtr	getSelf ()
	Return our self pointer. More...

ConstElementPtr	getSelf () const
	Return our self pointer. More...

ElementPtr	getParent ()
	Return our parent element. More...

ConstElementPtr	getParent () const
	Return our parent element. More...

ElementPtr	getRoot ()
	Return the root element of our tree. More...

ConstElementPtr	getRoot () const
	Return the root element of our tree. More...

DocumentPtr	getDocument ()
	Return the root document of our tree. More...

ConstDocumentPtr	getDocument () const
	Return the root document of our tree. More...

template<class T >
shared_ptr< const T >	getAncestorOfType () const

TreeIterator	traverseTree () const

GraphIterator	traverseGraph () const

virtual Edge	getUpstreamEdge (size_t index=0) const

virtual size_t	getUpstreamEdgeCount () const
	Return the number of queriable upstream edges for this element. More...

ElementPtr	getUpstreamElement (size_t index=0) const

InheritanceIterator	traverseInheritance () const

void	setSourceUri (const string &sourceUri)

bool	hasSourceUri () const
	Return true if this element has a source URI. More...

const string &	getSourceUri () const
	Return the element's source URI. More...

const string &	getActiveSourceUri () const

void	copyContentFrom (const ConstElementPtr &source)

virtual void	clearContent ()
	Clear all attributes and descendants from this element. More...

string	createValidChildName (string name) const

StringResolverPtr	createStringResolver (const string &geom=EMPTY_STRING) const

string	asString () const

Static Public Attributes
static const string	CATEGORY

static const string	INCLUDE_GEOM_ATTRIBUTE

static const string	EXCLUDE_GEOM_ATTRIBUTE

static const string	INCLUDE_COLLECTION_ATTRIBUTE

Static Public Attributes inherited from Element
static const string	NAME_ATTRIBUTE

static const string	FILE_PREFIX_ATTRIBUTE

static const string	GEOM_PREFIX_ATTRIBUTE

static const string	COLOR_SPACE_ATTRIBUTE

static const string	INHERIT_ATTRIBUTE

static const string	NAMESPACE_ATTRIBUTE

static const string	DOC_ATTRIBUTE

Additional Inherited Members
Protected Types inherited from Element
using	DocumentPtr = shared_ptr< Document >

using	ConstDocumentPtr = shared_ptr< const Document >

Protected Member Functions inherited from Element
	Element (ElementPtr parent, const string &category, const string &name)

template<class T >
shared_ptr< T >	resolveNameReference (const string &name, ConstElementPtr parent=nullptr) const

void	validateRequire (bool expression, bool &res, string *message, const string &errorDesc) const

virtual void	registerChildElement (ElementPtr child)

virtual void	unregisterChildElement (ElementPtr child)

ElementPtr	getSelfNonConst () const

Protected Attributes inherited from Element
string	_category

string	_name

string	_sourceUri

ElementMap	_childMap

vector< ElementPtr >	_childOrder

StringMap	_attributeMap

StringVec	_attributeOrder

weak_ptr< Element >	_parent

weak_ptr< Element >	_root

Detailed Description

A collection element within a Document.

Definition at line 436 of file Geom.h.

Constructor & Destructor Documentation

Collection::Collection	(	ElementPtr	parent,
		const string &	name
	)

inline

Definition at line 439 of file Geom.h.

virtual Collection::~Collection ( )

inlinevirtual

Definition at line 443 of file Geom.h.

Member Function Documentation

string Collection::getActiveExcludeGeom ( ) const

inline

Return the active exclude geometry string of this element, taking all geometry string substitutions at this scope into account.

Definition at line 499 of file Geom.h.

string Collection::getActiveIncludeGeom ( ) const

inline

Return the active include geometry string of this element, taking all geometry string substitutions at this scope into account.

Definition at line 468 of file Geom.h.

const string& Collection::getExcludeGeom ( ) const

inline

Return the exclude geometry string of this element.

Definition at line 492 of file Geom.h.

vector<CollectionPtr> Collection::getIncludeCollections ( ) const

Return the vector of collections that are directly included by this element.

const string& Collection::getIncludeCollectionString ( ) const

inline

Return the include collection string of this element.

Definition at line 523 of file Geom.h.

const string& Collection::getIncludeGeom ( ) const

inline

Return the include geometry string of this element.

Definition at line 461 of file Geom.h.

bool Collection::hasExcludeGeom ( ) const

inline

Return true if this element has an exclude geometry string.

Definition at line 486 of file Geom.h.

bool Collection::hasIncludeCollectionString ( ) const

inline

Return true if this element has an include collection string.

Definition at line 517 of file Geom.h.

bool Collection::hasIncludeCycle ( ) const

Return true if the include chain for this element contains a cycle.

bool Collection::hasIncludeGeom ( ) const

inline

Return true if this element has an include geometry string.

Definition at line 455 of file Geom.h.

bool Collection::matchesGeomString ( const string & geom ) const

Return true if this collection and the given geometry string have any geometries in common.

Exceptions

ExceptionFoundCycle if a cycle is encountered.

void Collection::setExcludeGeom ( const string & geom )

inline

Set the exclude geometry string of this element.

Definition at line 480 of file Geom.h.

void Collection::setIncludeCollection ( ConstCollectionPtr collection )

Set the collection that is directly included by this element.

void Collection::setIncludeCollections ( const vector< ConstCollectionPtr > & collections )

Set the vector of collections that are directly included by this element.

void Collection::setIncludeCollectionString ( const string & collection )

inline

Set the include collection string of this element.

Definition at line 511 of file Geom.h.

void Collection::setIncludeGeom ( const string & geom )

inline

Set the include geometry string of this element.

Definition at line 449 of file Geom.h.

bool Collection::validate ( string * message = nullptr ) const

overridevirtual

Validate that the given element tree, including all descendants, is consistent with the MaterialX specification.

Reimplemented from Element.

Member Data Documentation

const string Collection::CATEGORY

static

Definition at line 562 of file Geom.h.

const string Collection::EXCLUDE_GEOM_ATTRIBUTE

static

Definition at line 564 of file Geom.h.

const string Collection::INCLUDE_COLLECTION_ATTRIBUTE

static

Definition at line 565 of file Geom.h.

const string Collection::INCLUDE_GEOM_ATTRIBUTE

static

Definition at line 563 of file Geom.h.

The documentation for this class was generated from the following file:

MaterialXCore/Geom.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation