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

#include <Node.h>

+ Inheritance diagram for GraphElement:

Public Member Functions

virtual ~GraphElement ()
 
Node Elements
NodePtr addNode (const string &category, const string &name=EMPTY_STRING, const string &type=DEFAULT_TYPE_STRING)
 
NodePtr addNodeInstance (ConstNodeDefPtr nodeDef, const string &name=EMPTY_STRING)
 Add a Node that is an instance of the given NodeDef. More...
 
NodePtr getNode (const string &name) const
 Return the Node, if any, with the given name. More...
 
vector< NodePtrgetNodes (const string &category=EMPTY_STRING) const
 
vector< NodePtrgetNodesOfType (const string &nodeType) const
 Return a vector of nodes in the graph which have a given type. More...
 
void removeNode (const string &name)
 Remove the Node, if any, with the given name. More...
 
Material Nodes
NodePtr addMaterialNode (const string &name=EMPTY_STRING, ConstNodePtr shaderNode=nullptr)
 
vector< NodePtrgetMaterialNodes () const
 Return a vector of all material nodes. More...
 
Backdrop Elements
BackdropPtr addBackdrop (const string &name=EMPTY_STRING)
 Add a Backdrop to the graph. More...
 
BackdropPtr getBackdrop (const string &name) const
 Return the Backdrop, if any, with the given name. More...
 
vector< BackdropPtrgetBackdrops () const
 Return a vector of all Backdrop elements in the graph. More...
 
void removeBackdrop (const string &name)
 Remove the Backdrop, if any, with the given name. More...
 
Utility
void flattenSubgraphs (const string &target=EMPTY_STRING, NodePredicate filter=nullptr)
 
vector< ElementPtrtopologicalSort () const
 
string asStringDot () const
 
- Public Member Functions inherited from InterfaceElement
virtual ~InterfaceElement ()
 
void setNodeDefString (const string &nodeDef)
 Set the NodeDef string for the interface. More...
 
bool hasNodeDefString () const
 Return true if the given interface has a NodeDef string. More...
 
const stringgetNodeDefString () const
 Return the NodeDef string for the interface. More...
 
InputPtr addInput (const string &name=EMPTY_STRING, const string &type=DEFAULT_TYPE_STRING)
 
InputPtr getInput (const string &name) const
 Return the Input, if any, with the given name. More...
 
vector< InputPtrgetInputs () const
 Return a vector of all Input elements. More...
 
size_t getInputCount () const
 Return the number of Input elements. More...
 
void removeInput (const string &name)
 Remove the Input, if any, with the given name. More...
 
InputPtr getActiveInput (const string &name) const
 
vector< InputPtrgetActiveInputs () const
 
OutputPtr addOutput (const string &name=EMPTY_STRING, const string &type=DEFAULT_TYPE_STRING)
 
OutputPtr getOutput (const string &name) const
 Return the Output, if any, with the given name. More...
 
vector< OutputPtrgetOutputs () const
 Return a vector of all Output elements. More...
 
size_t getOutputCount () const
 Return the number of Output elements. More...
 
void removeOutput (const string &name)
 Remove the Output, if any, with the given name. More...
 
OutputPtr getActiveOutput (const string &name) const
 
vector< OutputPtrgetActiveOutputs () const
 
void setConnectedOutput (const string &inputName, OutputPtr output)
 
OutputPtr getConnectedOutput (const string &inputName) const
 
TokenPtr addToken (const string &name=EMPTY_STRING)
 
TokenPtr getToken (const string &name) const
 Return the Token, if any, with the given name. More...
 
vector< TokenPtrgetTokens () const
 Return a vector of all Token elements. More...
 
void removeToken (const string &name)
 Remove the Token, if any, with the given name. More...
 
TokenPtr getActiveToken (const string &name) const
 
vector< TokenPtrgetActiveTokens () const
 
ValueElementPtr getValueElement (const string &name) const
 Return the ValueElement, if any, with the given name. More...
 
ValueElementPtr getActiveValueElement (const string &name) const
 
vector< ValueElementPtrgetActiveValueElements () const
 
template<class T >
InputPtr setInputValue (const string &name, const T &value, const string &type=EMPTY_STRING)
 
ValuePtr getInputValue (const string &name, const string &target=EMPTY_STRING) const
 
TokenPtr setTokenValue (const string &name, const string &value)
 
string getTokenValue (const string &name)
 
void setTarget (const string &target)
 Set the target string of this interface. More...
 
bool hasTarget () const
 Return true if the given interface has a target string. More...
 
const stringgetTarget () const
 Return the target string of this interface. More...
 
void setVersionString (const string &version)
 Set the version string of this interface. More...
 
bool hasVersionString () const
 Return true if this interface has a version string. More...
 
const stringgetVersionString () const
 Return the version string of this interface. More...
 
void setVersionIntegers (int majorVersion, int minorVersion)
 Set the major and minor versions as an integer pair. More...
 
virtual std::pair< int, intgetVersionIntegers () const
 Return the major and minor versions as an integer pair. More...
 
void setDefaultVersion (bool defaultVersion)
 Set the default version flag of this element. More...
 
bool getDefaultVersion () const
 Return the default version flag of this element. More...
 
virtual ConstNodeDefPtr getDeclaration (const string &target=EMPTY_STRING) const
 
bool hasExactInputMatch (ConstInterfaceElementPtr declaration, string *message=nullptr) const
 
- Public Member Functions inherited from TypedElement
virtual ~TypedElement ()
 
void setType (const string &type)
 Set the element's type string. More...
 
bool hasType () const
 Return true if the given element has a type string. More...
 
virtual const stringgetType () const
 Return the element's type string. More...
 
bool isMultiOutputType () const
 Return true if the element is of multi-output type. More...
 
TypeDefPtr getTypeDef () const
 
- Public Member Functions inherited from Element
virtual ~Element ()
 
 Element (const Element &)=delete
 
Elementoperator= (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 stringgetCategory () const
 
void setName (const string &name)
 
const stringgetName () 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 stringgetFilePrefix () const
 Return the element's file prefix string. More...
 
const stringgetActiveFilePrefix () 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 stringgetGeomPrefix () const
 Return the element's geom prefix string. More...
 
const stringgetActiveGeomPrefix () 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 stringgetColorSpace () const
 Return the element's color space string. More...
 
const stringgetActiveColorSpace () 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 stringgetInheritString () 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 stringgetNamespace () 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< TasA ()
 Dynamic cast to an instance of the given subclass. More...
 
template<class T >
shared_ptr< const TasA () const
 Dynamic cast to a const instance of the given subclass. More...
 
template<class T >
shared_ptr< TaddChild (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< TgetChildOfType (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 stringgetAttribute (const string &attrib) const
 
const StringVecgetAttributeNames () 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 TgetAncestorOfType () 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 stringgetSourceUri () const
 Return the element's source URI. More...
 
const stringgetActiveSourceUri () const
 
virtual bool validate (string *message=nullptr) const
 
void copyContentFrom (const ConstElementPtr &source)
 
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
 
template<class T >
shared_ptr< TresolveRootNameReference (const string &name) const
 

Protected Member Functions

 GraphElement (ElementPtr parent, const string &category, const string &name)
 
- Protected Member Functions inherited from InterfaceElement
 InterfaceElement (ElementPtr parent, const string &category, const string &name)
 
void registerChildElement (ElementPtr child) override
 
void unregisterChildElement (ElementPtr child) override
 
- Protected Member Functions inherited from TypedElement
 TypedElement (ElementPtr parent, const string &category, const string &name)
 
- Protected Member Functions inherited from Element
 Element (ElementPtr parent, const string &category, const string &name)
 
void validateRequire (bool expression, bool &res, string *message, string errorDesc) const
 
ElementPtr getSelfNonConst () const
 

Additional Inherited Members

- Static Public Attributes inherited from InterfaceElement
static const string NODE_DEF_ATTRIBUTE
 
static const string TARGET_ATTRIBUTE
 
static const string VERSION_ATTRIBUTE
 
static const string DEFAULT_VERSION_ATTRIBUTE
 
- Static Public Attributes inherited from TypedElement
static const string TYPE_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
 
- Protected Types inherited from InterfaceElement
using NodeDefPtr = shared_ptr< NodeDef >
 
using ConstNodeDefPtr = shared_ptr< const NodeDef >
 
- Protected Types inherited from TypedElement
using TypeDefPtr = shared_ptr< class TypeDef >
 
- Protected Types inherited from Element
using DocumentPtr = shared_ptr< Document >
 
using ConstDocumentPtr = shared_ptr< const Document >
 
- 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

The base class for graph elements such as NodeGraph and Document.

Definition at line 182 of file Node.h.

Constructor & Destructor Documentation

GraphElement::GraphElement ( ElementPtr  parent,
const string category,
const string name 
)
inlineprotected

Definition at line 185 of file Node.h.

virtual GraphElement::~GraphElement ( )
inlinevirtual

Definition at line 191 of file Node.h.

Member Function Documentation

BackdropPtr GraphElement::addBackdrop ( const string name = EMPTY_STRING)
inline

Add a Backdrop to the graph.

Definition at line 273 of file Node.h.

NodePtr GraphElement::addMaterialNode ( const string name = EMPTY_STRING,
ConstNodePtr  shaderNode = nullptr 
)

Add a material node to the graph, optionally connecting it to the given shader node.

NodePtr GraphElement::addNode ( const string category,
const string name = EMPTY_STRING,
const string type = DEFAULT_TYPE_STRING 
)
inline

Add a Node to the graph.

Parameters
categoryThe category of the new Node.
nameThe name of the new Node. If no name is specified, then a unique name will automatically be generated.
typeAn optional type string.
Returns
A shared pointer to the new Node.

Definition at line 203 of file Node.h.

NodePtr GraphElement::addNodeInstance ( ConstNodeDefPtr  nodeDef,
const string name = EMPTY_STRING 
)
inline

Add a Node that is an instance of the given NodeDef.

Definition at line 214 of file Node.h.

string GraphElement::asStringDot ( ) const

Convert this graph to a string in the DOT language syntax. This can be used to visualise the graph using GraphViz (http://www.graphviz.org).

If declarations for the contained nodes are provided as nodedefs in the owning document, then they will be used to provide additional formatting details.

void GraphElement::flattenSubgraphs ( const string target = EMPTY_STRING,
NodePredicate  filter = nullptr 
)

Flatten any references to graph-based node definitions within this node graph, replacing each reference with the equivalent node network.

BackdropPtr GraphElement::getBackdrop ( const string name) const
inline

Return the Backdrop, if any, with the given name.

Definition at line 279 of file Node.h.

vector<BackdropPtr> GraphElement::getBackdrops ( ) const
inline

Return a vector of all Backdrop elements in the graph.

Definition at line 285 of file Node.h.

vector<NodePtr> GraphElement::getMaterialNodes ( ) const
inline

Return a vector of all material nodes.

Definition at line 263 of file Node.h.

NodePtr GraphElement::getNode ( const string name) const
inline

Return the Node, if any, with the given name.

Definition at line 222 of file Node.h.

vector<NodePtr> GraphElement::getNodes ( const string category = EMPTY_STRING) const
inline

Return a vector of all Nodes in the graph, optionally filtered by the given category string.

Definition at line 229 of file Node.h.

vector<NodePtr> GraphElement::getNodesOfType ( const string nodeType) const
inline

Return a vector of nodes in the graph which have a given type.

Definition at line 235 of file Node.h.

void GraphElement::removeBackdrop ( const string name)
inline

Remove the Backdrop, if any, with the given name.

Definition at line 291 of file Node.h.

void GraphElement::removeNode ( const string name)
inline

Remove the Node, if any, with the given name.

Definition at line 249 of file Node.h.

vector<ElementPtr> GraphElement::topologicalSort ( ) const

Return a vector of all children (nodes and outputs) sorted in topological order.

Exceptions
ExceptionFoundCycleif a cycle is encountered.

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