RenderPathData Struct Reference

#include <lib_token.h>

Detailed Description

Data structure to collect render information in handling Tokens in render output path.

Public Member Functions

 RenderPathData (BaseDocument *doc=nullptr, RenderData *rData=nullptr, BaseContainer *rBc=nullptr, BaseTake *take=nullptr, Int32 frame=NOTOK, const String &layerName=String(), const String &layerTypeName=String(), Int32 layerType=NOTOK, Bool isLight=false, Int32 lightNumber=NOTOK, Bool isMaterial=false, const String &nodeName=String(), BaseList2D *node=nullptr)
 

Public Attributes

BaseDocument_doc
 
RenderData_rData
 
BaseContainer_rBc
 
BaseTake_cTake
 
Int32 _frame
 
String _layerName
 
String _layerTypeName
 
Int32 _layerType
 
Bool _isLight
 
Int32 _lightNumber
 
Bool _isMaterial
 
String _nodeName
 
Bool _checkUnresolved
 
BaseList2D_node
 

Constructor & Destructor Documentation

◆ RenderPathData()

RenderPathData ( BaseDocument doc = nullptr,
RenderData rData = nullptr,
BaseContainer rBc = nullptr,
BaseTake take = nullptr,
Int32  frame = NOTOK,
const String layerName = String(),
const String layerTypeName = String(),
Int32  layerType = NOTOK,
Bool  isLight = false,
Int32  lightNumber = NOTOK,
Bool  isMaterial = false,
const String nodeName = String(),
BaseList2D node = nullptr 
)

Constructor.

Parameters
[in]docThe BaseDocument used for rendering, can be a clone of original document.
[in]rDataThe RenderData used for rendering.
[in]rBcThe BaseContainer with the render settings (can be different from _rData->GetDataInstance() eg. RQ change paths).
[in]takeThe BaseTake used for rendering.
[in]frameThe frame number used for rendering or NOTOK if the frame is not yet recognized.
[in]layerNameThe pass user name if multipass is activated.
[in]layerTypeNameThe pass type name if multipass is activated.
[in]layerTypeThe pass ID used for rendering or NOTOK if multipass is not active or not yet recognized.
[in]isLighttrue if the pass is a separated light pass.
[in]lightNumberThe light number id.
[in]isMaterialtrue if the pass is a separated reflectance material pass.
[in]nodeNameif _isLight is true or _isMaterial is true store here the object scene name.
[in]nodeAn owner node for certain tokens such as MoGraph cache tokens.

Member Data Documentation

◆ _doc

BaseDocument* _doc

The BaseDocument used for rendering, can be a clone of original document.

◆ _rData

RenderData* _rData

The RenderData used for rendering.

◆ _rBc

The BaseContainer with the render settings (can be different from _rData->GetDataInstance() eg. RQ change paths).

◆ _cTake

BaseTake* _cTake

The BaseTake used for rendering.

◆ _frame

Int32 _frame

The frame number used for rendering or NOTOK if the frame is not yet recognized.

◆ _layerName

String _layerName

The pass user name if multipass is activated.

◆ _layerTypeName

String _layerTypeName

The pass type name if multipass is activated.

◆ _layerType

Int32 _layerType

The pass ID used for rendering or NOTOK if multipass is not active or not yet recognized.

◆ _isLight

Bool _isLight

true if the pass is a separated light pass.

◆ _lightNumber

Int32 _lightNumber

The light number id.

◆ _isMaterial

Bool _isMaterial

true if the pass is a separated reflectance material pass.

◆ _nodeName

String _nodeName

if _isLight is true or _isMaterial is true store here the object scene name.

◆ _checkUnresolved

Bool _checkUnresolved

if true warning strings will be used for the Tokens that cannot be resolved.

◆ _node

BaseList2D* _node

An owner node for certain tokens such as MoGraph cache tokens.

Since
R18