RenderData Class Reference

#include <c4d_basedocument.h>

Inheritance diagram for RenderData:

详细描述

The RenderData class contains a container with all render settings. One can add multiple render data classes to a document. The active one will be used for the render.
The render settings in Cinema 4D are description based. The valid IDs are listed in drendersettings.h (open Cinema 4D render settings for more information, see drendersettings.res for the container definition).

注意
Has to be created with Alloc() and destroyed with Free() 。使用 AutoAlloc to automate the allocation and destruction based on scope.

私有成员函数

  RenderData ()
  ~RenderData ()

Alloc/Free

static RenderData Alloc (void)
static void  Free ( RenderData *&bl)

导航

RenderData GetNext (void)
RenderData GetPred (void)
RenderData GetUp (void)
RenderData GetDown (void)
RenderData GetDownLast (void)

VideoPost

BaseVideoPost GetFirstVideoPost ()
void  InsertVideoPost ( BaseVideoPost *pvp, BaseVideoPost *pred=nullptr)
void  InsertVideoPostLast ( BaseVideoPost *pvp)

Multipass

MultipassObject GetFirstMultipass ()
void  InsertMultipass ( MultipassObject *obj, MultipassObject *pred=nullptr)

Additional Inherited Members

-  Public Member Functions inherited from BaseList2D
const Char GetViewportRenderId ( VIEWPORT_RENDER_ID typeId) const
BaseList2D GetNext ()
BaseList2D GetPred ()
void  SetBit ( Int32 mask)
Bool   GetBit ( Int32 mask) const
void  DelBit ( Int32 mask)
void  ToggleBit ( Int32 mask)
Int32   GetAllBits () const
void  SetAllBits ( Int32 bits)
void  SetBitEx ( Int32 mask, Int32 flags)
BaseContainer   GetData ()
void  SetData (const BaseContainer &bc, Bool add=true)
const BaseContainer GetDataInstance () const
BaseContainer GetDataInstance ()
const BaseContainer GetDataInstanceRef () const
BaseContainer GetDataInstanceRef ()
String   GetName () const
void  SetName (const maxon::String &name)
String   GetBubbleHelp ()
Bool   TransferGoal ( BaseList2D *dst, Bool undolink)
Bool   TransferMarker ( BaseList2D *dst) const
Bool   比例 ( Float scale)
Bool   编辑 ()
void  GetIcon ( IconData *dat)
GeListHead GetNLARoot ()
BaseList2D AnimationLayerRemap ( BaseObject **layer=nullptr)
String   GetTypeName ()
BaseList2D GetMain () const
void  InsertTrackSorted ( CTrack *track)
Bool   AddEventNotification ( BaseList2D *bl, NOTIFY_EVENT eventid, NOTIFY_EVENT_FLAG flags, const BaseContainer *data)
Bool   RemoveEventNotification ( BaseDocument *doc, BaseList2D *bl, NOTIFY_EVENT eventid)
Bool   FindEventNotification ( BaseDocument *doc, BaseList2D *bl, NOTIFY_EVENT eventid)
Bool   SetDescIDState (const DescID &id, DESCIDSTATE descidstate)
DESCIDSTATE   GetDescIDState (const DescID &id, Bool tolerant) const
GeListHead GetOverrideRoot ()
BaseOverride GetFirstOverride ()
GeListHead GetShaderRepositoryRoot ()
GeListHead GetHiddenShaderRoot ()
maxon::NimbusInterface *  GetNimbusRef (const maxon::Id &spaceId) const
maxon::Result < maxon::NimbusInterface * >  GetOrCreateNimbusRef (const maxon::Id &spaceId)
void  RemoveNimbusRef (const maxon::Id &spaceId)
maxon::Result < maxon::HashMap < maxon::Id , maxon::ForwardRef < maxon::NimbusRef > > >  GetAllNimbusRefs () const
Bool   IsNodeBased () const
void  GetMarkerStampEx ( UInt32 *l1, UInt32 *l2)
const GeMarker GetMarker () const
void  SetMarker (const GeMarker &m)
Bool   AddUniqueID ( Int32 appid, const Char *const mem, Int bytes)
Bool   FindUniqueID ( Int32 appid, const Char *&mem, Int &bytes) const
Int32   GetUniqueIDCount () const
Bool   GetUniqueIDIndex ( Int32 idx, Int32 &id, const Char *&mem, Int &bytes) const
Bool   SetAnimatedParameter ( CTrack *track, const DescID &id, const GeData &t_data1, const GeData &t_data2, Float mix, DESCFLAGS_SET flags)
Bool   GetAnimatedParameter (const DescID &id, GeData &t_data1, GeData &t_data2, Float &mix, DESCFLAGS_GET flags)
BaseShader GetFirstShader () const
void  InsertShader ( BaseShader *shader, BaseShader *pred=nullptr)
void  ClearKeyframeSelection ()
Bool   FindKeyframeSelection (const DescID &id)
Bool   SetKeyframeSelection (const DescID &id, Bool selection)
Bool   KeyframeSelectionContent ()
LayerObject GetLayerObject ( BaseDocument *doc)
Bool   SetLayerObject ( LayerObject *layer)
const LayerData GetLayerData ( BaseDocument *doc, Bool rawdata=false)
Bool   SetLayerData ( BaseDocument *doc, const LayerData &data)
GeListHead GetCTrackRoot ()
CTrack GetFirstCTrack ()
CTrack FindCTrack (const DescID &id)
-  Public Member Functions inherited from GeListNode
GeListNode GetNext ()
GeListNode GetPred ()
GeListNode GetDown ()
GeListNode GetUp ()
GeListNode GetDownLast ()
void  InsertBefore ( GeListNode *bl)
void  InsertAfter ( GeListNode *bl)
void  InsertUnder ( GeListNode *bl)
void  InsertUnderLast ( GeListNode *bl)
void  移除 ()
GeListHead GetListHead ()
Int32   GetNodeID ( Int32 index=0) const
template<typename CAST >
const CAST *  GetNodeData ( Int32 index=0) const
template<typename CAST >
CAST *  GetNodeData ( Int32 index=0)
void  SetCustomData ( GeListNode *node)
GeListNode GetCustomData ()
BaseDocument GetDocument ()
Int32   GetBranchInfo ( BranchInfo *info, Int32 max, GETBRANCHINFO flags)
Bool   IsDocumentRelated ()
Int32   GetInfo ()
Bool   GetNBit ( NBIT bit) const
UInt32   GetNBitMask ( Int32 index) const
Bool   ChangeNBit ( NBIT bit, NBITCONTROL bitmode)
-  Public Member Functions inherited from C4DAtom
Int32   GetType () const
Int32   GetRealType () const
Int32   GetDiskType () const
Bool   IsInstanceOf ( Int32 id) const
Int32   GetClassification () const
Bool   消息 ( Int32 type, void *data=nullptr)
Bool   MultiMessage ( MULTIMSG_ROUTE flags, Int32 type, void *data)
C4DAtom GetClone ( COPYFLAGS flags, AliasTrans *trn)
Bool   CopyTo ( C4DAtom *dst, COPYFLAGS flags, AliasTrans *trn)
Bool   读取 ( HyperFile *hf, Int32 id, Int32 level)
Bool   Write ( HyperFile *hf)
Bool   ReadObject ( HyperFile *hf, Bool readheader)
Bool   WriteObject ( HyperFile *hf)
Bool   GetDescription ( 描述 *description, DESCFLAGS_DESC flags)
Bool   GetParameter (const DescID &id, GeData &t_data, DESCFLAGS_GET flags)
Bool   SetParameter (const DescID &id, const GeData &t_data, DESCFLAGS_SET flags)
DynamicDescription GetDynamicDescription ()
Bool   GetEnabling (const DescID &id, const GeData &t_data, DESCFLAGS_ENABLE flags, const BaseContainer *itemdesc)
Bool   TranslateDescID (const DescID &id, DescID &res_id, C4DAtom *&res_at)
UInt32   GetDirty ( DIRTYFLAGS flags) const
void  SetDirty ( DIRTYFLAGS flags)
UInt32   GetHDirty ( HDIRTYFLAGS mask) const
void  SetHDirty ( HDIRTYFLAGS mask)
-  Static Public Member Functions inherited from BaseList2D
static BaseList2D Alloc ( Int32 type)
static void  Free ( BaseList2D *&bl)
-  Static Public Attributes inherited from BaseList2D
static const Int32   SETBIT_FLAG_NODIRTY
static const Int32   SETBIT_FLAG_REMOVE

构造函数 & 析构函数文档编制

◆  RenderData()

RenderData () private

◆  ~RenderData()

~ RenderData () private

成员函数文档编制

◆  Alloc()

static RenderData * Alloc ( void  )
static

Allocates a render data. Destroy the allocated render data with Free() 。使用 AutoAlloc to automate the allocation and destruction based on scope.

返回
The allocated render data, or nullptr if the allocation failed.

◆  Free()

static void Free ( RenderData *&  bl )
static

Destructs render data allocated with Alloc() 。使用 AutoAlloc to automate the allocation and destruction based on scope.

参数
[in,out] bl The render data to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

◆  GetNext()

RenderData * GetNext ( void  )

Gets the next render data in the list. Convenience version of GeListNode::GetNext() returning a pointer to a RenderData .

返回
The next render data, or nullptr if there is none. Cinema 4D owns the pointed render data.

◆  GetPred()

RenderData * GetPred ( void  )

Gets the previous render data in the list. Convenience version of GeListNode::GetPred() returning a pointer to a RenderData .

返回
The previous render data, or nullptr if there is none. Cinema 4D owns the pointed render data.

◆  GetUp()

RenderData * GetUp ( void  )

Gets the parent render data of the list node. Convenience version of GeListNode::GetUp() returning a pointer to a RenderData .

返回
The parent render data, or nullptr if there is none. Cinema 4D owns the pointed render data.

◆  GetDown()

RenderData * GetDown ( void  )

Gets the first child render data of the list node. Convenience version of GeListNode::GetDown() returning a pointer to a RenderData .

返回
The first child render data, or nullptr if there is none. Cinema 4D owns the pointed render data.

◆  GetDownLast()

RenderData * GetDownLast ( void  )

Gets the last child render data of the list node. Convenience version of GeListNode::GetDownLast() returning a pointer to a RenderData .

返回
The last child render data, or nullptr if there is none. Cinema 4D owns the pointed render data.

◆  GetFirstVideoPost()

BaseVideoPost * GetFirstVideoPost ( )

Gets the first video post of the render data.

返回
The first video post. The render data owns the pointed video post.

◆  InsertVideoPost()

void InsertVideoPost ( BaseVideoPost pvp ,
BaseVideoPost pred = nullptr  
)

Inserts pvp as a video post in the render data. The insertion position can be specified with pred , inserting the video post below the specified pred video post.

参数
[in] pvp The video post to insert. The render data takes over the ownership of the pointed video post.
[in] pred The optional video post to insert pvp after, or nullptr (default) to insert it first.

◆  InsertVideoPostLast()

void InsertVideoPostLast ( BaseVideoPost pvp )

Inserts pvp as the last video post in the render data.

参数
[in] pvp The video post to insert last. The render data takes over the ownership of the pointed video post.

◆  GetFirstMultipass()

MultipassObject * GetFirstMultipass ( )

Gets the first multipass channel MultipassObject of the render data. The other multipass channels in the render data can be accessed by using the base class list functions, MultipassObject::GetNext() .

返回
The first multipass channel, or nullptr if there is no multipass channels in the render data. The render data owns the pointed multipass.

◆  InsertMultipass()

void InsertMultipass ( MultipassObject obj ,
MultipassObject pred = nullptr  
)

Inserts the multipass channel obj into the render data.
The insertion position can be specified with pred , inserting the multipass below the specified pred multipass. Otherwise the multipass channel is inserted at the first position in the list.

参数
[in] obj The multipass channel to insert. The render data takes over the ownership of the pointed multipass.
[in] pred The optional multipass to insert obj after, or nullptr (default) to insert it first.