MaterialX  1.38.5
Public Member Functions | List of all members
Edge Class Reference

An edge between two connected Elements, returned during graph traversal. More...

#include <Traversal.h>

Public Member Functions

 Edge (ElementPtr elemDown, ElementPtr elemConnect, ElementPtr elemUp)
 
bool operator== (const Edge &rhs) const
 
bool operator!= (const Edge &rhs) const
 
bool operator< (const Edge &rhs) const
 
 operator bool () const
 
ElementPtr getDownstreamElement () const
 Return the downstream element of the edge.
 
ElementPtr getConnectingElement () const
 Return the connecting element of the edge, if any.
 
ElementPtr getUpstreamElement () const
 Return the upstream element of the edge.
 
string getName () const
 Return the name of this edge, if any.
 

Detailed Description

An edge between two connected Elements, returned during graph traversal.

A valid Edge consists of a downstream element, an upstream element, and optionally a connecting element that binds them. As an example, the edge between two Node elements will contain a connecting element for the Input of the downstream Node.

See also
Element::traverseGraph

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