BifrostGraph::MayaTranslation::ValueData Class Reference

Translation data used to pass Maya data between compute node and converter. More...

#include <HostData.h>

Inheritance diagram for BifrostGraph::MayaTranslation::ValueData:

Public Member Functions
	ValueData (MPlug const &plug, MDataBlock &block, void *&extraHandle, Amino::Ptr< Amino::Any > const &cachedValue, Amino::MetadataItem const *inputPathOpts=nullptr)
	Constructor always called by maya. User should not create the object itself. More...
	~ValueData () final
	Destructor always called by maya. User should not destroy the object itself. More...
const MPlug &	getPlug () const
MDataBlock &	getDataBlock () const
const Amino::MetadataItem *	getInputPathOptions () const
void *&	getExtraHandle () const
const Amino::Ptr< Amino::Any > &	getCachedValue () const
ValueData &	operator= (const ValueData &)=delete
	Enforce the correct usage of this object by disallowing. More...
	ValueData (const ValueData &)=delete
	Enforce the correct usage of this object by disallowing. More...
Public Member Functions inherited from BifrostGraph::Executor::TypeTranslation::ValueData
	ValueData () noexcept
virtual	~ValueData () noexcept

Detailed Description

Translation data used to pass Maya data between compute node and converter.

Note

This will be created by Maya and send to converter.

See also

BifrostGraph::Executor::TypeTranslation::convertValueFromHost()

BifrostGraph::Executor::TypeTranslation::convertValueToHost()

Note

This class belongs to a feature that is still under development and may change in subsequent versions.

Definition at line 48 of file HostData.h.

Constructor & Destructor Documentation

ValueData() [1/2]

BifrostGraph::MayaTranslation::ValueData::ValueData ( MPlug const &  plug, MDataBlock &  block, void *&  extraHandle, Amino::Ptr< Amino::Any > const &  cachedValue, Amino::MetadataItem const *  inputPathOpts = nullptr  )

inline

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

Parameters

plug	The plug attribute for which data should be read/written.
block	Data block of the node holding the plug
extraHandle	RESERVED FOR INTERNAL USE
cachedValue	RESERVED FOR INTERNAL USE
inputPathOpts	Input by path option.

Definition at line 58 of file HostData.h.

~ValueData()

BifrostGraph::MayaTranslation::ValueData::~ValueData ( )

finalvirtual

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

Reimplemented from BifrostGraph::Executor::TypeTranslation::ValueData.

ValueData() [2/2]

BifrostGraph::MayaTranslation::ValueData::ValueData ( const ValueData &  )

delete

Enforce the correct usage of this object by disallowing.

Member Function Documentation

getCachedValue()

const Amino::Ptr< Amino::Any > & BifrostGraph::MayaTranslation::ValueData::getCachedValue ( ) const

inline

Definition at line 96 of file HostData.h.

getDataBlock()

MDataBlock & BifrostGraph::MayaTranslation::ValueData::getDataBlock ( ) const

inline

Returns

Data block of the node holding the plug.

Note

: We need to store and return a non-const MDataBlock reference because the class MDataBlock has no const methods.

Definition at line 87 of file HostData.h.

getExtraHandle()

void *& BifrostGraph::MayaTranslation::ValueData::getExtraHandle ( ) const

inline

Definition at line 93 of file HostData.h.

getInputPathOptions()

const Amino::MetadataItem * BifrostGraph::MayaTranslation::ValueData::getInputPathOptions ( ) const

inline

Returns

The input path options.

Definition at line 90 of file HostData.h.

getPlug()

const MPlug & BifrostGraph::MayaTranslation::ValueData::getPlug ( ) const

inline

Returns

The plug attribute for which data should be read/written.

Definition at line 82 of file HostData.h.

operator=()

ValueData & BifrostGraph::MayaTranslation::ValueData::operator= ( const ValueData &  )

delete

Enforce the correct usage of this object by disallowing.