Bifrost SDK
Bifrost SDK documentation
BifrostGraph::MayaTranslation::PortCreationData Class Referencefinal

Translation data used to create Maya ports. This will be created by Maya. More...

#include <HostData.h>

Inheritance diagram for BifrostGraph::MayaTranslation::PortCreationData:
BifrostGraph::MayaTranslation::PortData BifrostGraph::Executor::TypeTranslation::PortData

Classes

struct  ConversionData
 To know if we are converting and to what. More...
 

Public Types

enum class  ConversionMode { kNone , kConversionToShape , kConversionToBoard }
 Mode to know if we are converting and to what. More...
 

Public Member Functions

 PortCreationData (PortData const &translationData, MDGModifier &modifier, ConversionData const &conversionData)
 Constructor always called by maya. User should not create the object itself. More...
 
 ~PortCreationData () final
 Destructor always called by maya. User should not destroy the object itself. More...
 
- Public Member Functions inherited from BifrostGraph::MayaTranslation::PortData
 PortData (MObject const &object, MTypeId const &id)
 Constructor always called by maya. User should not create the object itself. More...
 
 PortData (PortData const &other)
 Copy constructor. More...
 
 ~PortData () override
 Destructor always called by maya. User should not destroy the object itself. More...
 
- Public Member Functions inherited from BifrostGraph::Executor::TypeTranslation::PortData
 PortData () noexcept
 
virtual ~PortData () noexcept
 

Public Attributes

MDGModifier & m_modifier
 The modifier to use to do DG operations, so they can be undo and redone. More...
 
ConversionData const & m_conversionData
 The conversion data involving the port creation. More...
 
- Public Attributes inherited from BifrostGraph::MayaTranslation::PortData
MObject const m_object
 The maya dependency node. More...
 
MTypeId const m_id
 The MTypeId of m_object. More...
 

Detailed Description

Translation data used to create Maya ports. This will be created by Maya.

See also
BifrostGraph::Executor::TypeTranslation::portAdded
Note
This class belongs to a feature that is still under development and may change in subsequent versions.

Definition at line 154 of file HostData.h.

Member Enumeration Documentation

◆ ConversionMode

Mode to know if we are converting and to what.

Enumerator
kNone 

Not converting node to anything.

kConversionToShape 

Converting to a bifrostGraphShape node.

kConversionToBoard 

Converting to a bifrostBoard node.

Definition at line 157 of file HostData.h.

Constructor & Destructor Documentation

◆ PortCreationData()

BifrostGraph::MayaTranslation::PortCreationData::PortCreationData ( PortData const &  translationData,
MDGModifier &  modifier,
ConversionData const &  conversionData 
)
inline

Constructor always called by maya. User should not create the object itself.

Parameters
translationDataTranslation data used to convert values from/to Maya.
modifierThe Maya modifier to use to do DG operations.
conversionDataThe conversion data involving the port creation.

Definition at line 176 of file HostData.h.

◆ ~PortCreationData()

BifrostGraph::MayaTranslation::PortCreationData::~PortCreationData ( )
final

Destructor always called by maya. User should not destroy the object itself.

Member Data Documentation

◆ m_conversionData

ConversionData const& BifrostGraph::MayaTranslation::PortCreationData::m_conversionData

The conversion data involving the port creation.

Definition at line 193 of file HostData.h.

◆ m_modifier

MDGModifier& BifrostGraph::MayaTranslation::PortCreationData::m_modifier

The modifier to use to do DG operations, so they can be undo and redone.

Definition at line 191 of file HostData.h.