#include <Look.h>

Inheritance diagram for Visibility:

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

virtual	~Visibility ()

Viewer Geom
void	setViewerGeom (const string &geom)
	Set the viewer geom string of the element. More...

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

const string &	getViewerGeom () const
	Return the viewer geom string of the element. More...

Viewer Collection
void	setViewerCollection (const string &collection)
	Set the viewer geom string of the element. More...

bool	hasViewerCollection () const
	Return true if the given element has a viewer collection string. More...

const string &	getViewerCollection () const
	Return the viewer collection string of the element. More...

Visibility Type
void	setVisibilityType (const string &type)
	Set the visibility type string of the element. More...

bool	hasVisibilityType () const
	Return true if the given element has a visibility type string. More...

const string &	getVisibilityType () const
	Return the visibility type string of the element. More...

Visible
void	setVisible (bool visible)
	Set the visible boolean of the element. More...

bool	getVisible () const
	Return the visible boolean of the element. More...

Public Member Functions inherited from GeomElement
virtual	~GeomElement ()

void	setGeom (const string &geom)
	Set the geometry string of this element. More...

bool	hasGeom () const
	Return true if this element has a geometry string. More...

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

string	getActiveGeom () const

void	setCollectionString (const string &collection)
	Set the collection string of this element. More...

bool	hasCollectionString () const
	Return true if this element has a collection string. More...

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

void	setCollection (ConstCollectionPtr collection)
	Assign a Collection to this element. More...

CollectionPtr	getCollection () const
	Return the Collection that is assigned to this element. More...

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	VIEWER_GEOM_ATTRIBUTE

static const string	VIEWER_COLLECTION_ATTRIBUTE

static const string	VISIBILITY_TYPE_ATTRIBUTE

static const string	VISIBLE_ATTRIBUTE

Static Public Attributes inherited from GeomElement
static const string	GEOM_ATTRIBUTE

static const string	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 GeomElement
	GeomElement (ElementPtr parent, const string &category, const string &name)

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 visibility element within a Look.

A Visibility describes the visibility relationship between two geometries or geometric collections.

Todo:: Add a Look::geomIsVisible method that computes the visibility between two geometries in the context of a specific Look.

Definition at line 391 of file Look.h.

Constructor & Destructor Documentation

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

inline

Definition at line 394 of file Look.h.

virtual Visibility::~Visibility ( )

inlinevirtual

Definition at line 398 of file Look.h.

Member Function Documentation

const string& Visibility::getViewerCollection ( ) const

inline

Return the viewer collection string of the element.

Definition at line 438 of file Look.h.

const string& Visibility::getViewerGeom ( ) const

inline

Return the viewer geom string of the element.

Definition at line 416 of file Look.h.

const string& Visibility::getVisibilityType ( ) const

inline

Return the visibility type string of the element.

Definition at line 460 of file Look.h.

bool Visibility::getVisible ( ) const

inline

Return the visible boolean of the element.

Definition at line 476 of file Look.h.

bool Visibility::hasViewerCollection ( ) const

inline

Return true if the given element has a viewer collection string.

Definition at line 432 of file Look.h.

bool Visibility::hasViewerGeom ( ) const

inline

Return true if the given element has a viewer geom string.

Definition at line 410 of file Look.h.

bool Visibility::hasVisibilityType ( ) const

inline

Return true if the given element has a visibility type string.

Definition at line 454 of file Look.h.

void Visibility::setViewerCollection ( const string & collection )

inline

Set the viewer geom string of the element.

Definition at line 426 of file Look.h.

void Visibility::setViewerGeom ( const string & geom )

inline

Set the viewer geom string of the element.

Definition at line 404 of file Look.h.

void Visibility::setVisibilityType ( const string & type )

inline

Set the visibility type string of the element.

Definition at line 448 of file Look.h.

void Visibility::setVisible ( bool visible )

inline

Set the visible boolean of the element.

Definition at line 470 of file Look.h.

Member Data Documentation

const string Visibility::CATEGORY

static

Definition at line 484 of file Look.h.

const string Visibility::VIEWER_COLLECTION_ATTRIBUTE

static

Definition at line 486 of file Look.h.

const string Visibility::VIEWER_GEOM_ATTRIBUTE

static

Definition at line 485 of file Look.h.

const string Visibility::VISIBILITY_TYPE_ATTRIBUTE

static

Definition at line 487 of file Look.h.

const string Visibility::VISIBLE_ATTRIBUTE

static

Definition at line 488 of file Look.h.

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

MaterialXCore/Look.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation