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

#include <connection.h>

Public Member Functions

 VdfConnection (VdfOutput &output, const VdfMask &mask, VdfInput &input)
 
const VdfNode & GetSourceNode () const
 Returns the source (ie. output) node for this connection. More...
 
VdfNode & GetSourceNode ()
 Returns the source (ie. output) node for this connection. More...
 
const VdfNode & GetTargetNode () const
 Returns the target (ie. input) node for this connection. More...
 
VdfNode & GetTargetNode ()
 Returns the target (ie. input) node for this connection. More...
 
const VdfOutput & GetSourceOutput () const
 Returns the output (ie. source) for this connection. More...
 
VdfOutput & GetSourceOutput ()
 Returns the output (ie. source) for this connection. More...
 
VdfOutput & GetNonConstSourceOutput () const
 Returns the output (ie. source) for this connection. More...
 
VdfMaskedOutput GetSourceMaskedOutput () const
 Return the masked output (ie. source) for this connection. More...
 
const VdfInput & GetTargetInput () const
 Returns the input connector (ie. target) for this connection. More...
 
VdfInput & GetTargetInput ()
 Returns the input connector (ie. target) for this connection. More...
 
const VdfMask & GetMask () const
 Returns the mask for this connection. More...
 
VDF_API std::string GetDebugName () const
 Returns a debug string for this connection. More...
 

Detailed Description

A class that fully represents a connection between two VdfNodes.

Definition at line 29 of file connection.h.

Constructor & Destructor Documentation

VdfConnection::VdfConnection ( VdfOutput &  output,
const VdfMask &  mask,
VdfInput &  input 
)
inline

Definition at line 33 of file connection.h.

Member Function Documentation

VDF_API std::string VdfConnection::GetDebugName ( ) const

Returns a debug string for this connection.

const VdfMask& VdfConnection::GetMask ( ) const
inline

Returns the mask for this connection.

Definition at line 99 of file connection.h.

VdfOutput& VdfConnection::GetNonConstSourceOutput ( ) const
inline

Returns the output (ie. source) for this connection.

Definition at line 76 of file connection.h.

VdfMaskedOutput VdfConnection::GetSourceMaskedOutput ( ) const
inline

Return the masked output (ie. source) for this connection.

Definition at line 82 of file connection.h.

const VdfNode& VdfConnection::GetSourceNode ( ) const
inline

Returns the source (ie. output) node for this connection.

Definition at line 39 of file connection.h.

VdfNode& VdfConnection::GetSourceNode ( )
inline

Returns the source (ie. output) node for this connection.

Definition at line 45 of file connection.h.

const VdfOutput& VdfConnection::GetSourceOutput ( ) const
inline

Returns the output (ie. source) for this connection.

Definition at line 63 of file connection.h.

VdfOutput& VdfConnection::GetSourceOutput ( )
inline

Returns the output (ie. source) for this connection.

Definition at line 69 of file connection.h.

const VdfInput& VdfConnection::GetTargetInput ( ) const
inline

Returns the input connector (ie. target) for this connection.

Definition at line 87 of file connection.h.

VdfInput& VdfConnection::GetTargetInput ( )
inline

Returns the input connector (ie. target) for this connection.

Definition at line 93 of file connection.h.

const VdfNode& VdfConnection::GetTargetNode ( ) const
inline

Returns the target (ie. input) node for this connection.

Definition at line 51 of file connection.h.

VdfNode& VdfConnection::GetTargetNode ( )
inline

Returns the target (ie. input) node for this connection.

Definition at line 57 of file connection.h.


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