HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GeomPath Class Reference

#include <Geom.h>

Public Member Functions

 GeomPath ()
 
 ~GeomPath ()
 
bool operator== (const GeomPath &rhs) const
 
bool operator!= (const GeomPath &rhs) const
 
 GeomPath (const string &geom)
 Construct a path from a geometry name string. More...
 
 operator string () const
 Convert a path to a geometry name string. More...
 
bool isMatching (const GeomPath &rhs, bool contains=false) const
 
bool isEmpty () const
 
bool isUniversal () const
 

Detailed Description

A MaterialX geometry path, representing the hierarchical location expressed by a geometry name.

Definition at line 60 of file Geom.h.

Constructor & Destructor Documentation

GeomPath::GeomPath ( )
inline

Definition at line 63 of file Geom.h.

GeomPath::~GeomPath ( )
inline

Definition at line 67 of file Geom.h.

GeomPath::GeomPath ( const string geom)
inlineexplicit

Construct a path from a geometry name string.

Definition at line 80 of file Geom.h.

Member Function Documentation

bool GeomPath::isEmpty ( ) const
inline

Return true if this geometry path is empty. An empty path matches no other geometry paths.

Definition at line 132 of file Geom.h.

bool GeomPath::isMatching ( const GeomPath rhs,
bool  contains = false 
) const
inline

Return true if there is any geometry in common between the two paths.

Parameters
rhsA second geometry path to be compared with this one
containsIf true, then we require that the first path completely contains the second one.

Definition at line 109 of file Geom.h.

bool GeomPath::isUniversal ( ) const
inline

Return true if this geometry path is universal. A universal path matches all non-empty geometry paths.

Definition at line 139 of file Geom.h.

GeomPath::operator string ( ) const
inline

Convert a path to a geometry name string.

Definition at line 87 of file Geom.h.

bool GeomPath::operator!= ( const GeomPath rhs) const
inline

Definition at line 74 of file Geom.h.

bool GeomPath::operator== ( const GeomPath rhs) const
inline

Definition at line 69 of file Geom.h.


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