BaseVideoPost Class Reference

#include <c4d_videopost.h>

Inheritance diagram for BaseVideoPost:

详细描述

Represents a videopost node.

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

To check if a videopost node is enabled use ! pvp -> GetBit ( BIT_VPDISABLED ).

私有成员函数

  BaseVideoPost ()
  ~BaseVideoPost ()

导航

static BaseVideoPost Alloc ( Int32 type)
static void  Free ( BaseVideoPost *&bl)
BaseVideoPost GetNext (void)
BaseVideoPost GetPred (void)

立体

Bool   StereoMergeImages ( BaseBitmap *dest, const BaseBitmap *const *source, Int32 cnt, const BaseContainer &settings, COLORSPACETRANSFORMATION transform)
Int32   StereoGetCameraCountEditor ( BaseDocument *doc, BaseDraw *bd)
Int32   StereoGetCameraCountRenderer ( BaseDocument *doc, RenderData *rd)
Bool   StereoGetCameraInfo ( BaseDocument *doc, BaseDraw *bd, RenderData *rd, Int32 index, StereoCameraInfo &info)

RenderEngineCheck

Bool   RenderEngineCheck ( Int32 id)

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

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

◆  BaseVideoPost()

BaseVideoPost () private

◆  ~BaseVideoPost()

~ BaseVideoPost () private

成员函数文档编制

◆  Alloc()

static BaseVideoPost * Alloc ( Int32   type )
static

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

参数
[in] type The videopost ID.
返回
The allocated videopost, or nullptr if the allocation failed.

◆  Free()

static void Free ( BaseVideoPost *&  bl )
static

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

参数
[in] bl The videopost to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

◆  GetNext()

BaseVideoPost * GetNext ( void  )

Gets the next videopost in the list. Convenience version of GeListNode::GetNext() .

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

◆  GetPred()

BaseVideoPost * GetPred ( void  )

Gets the previous videopost in the list. Convenience version of GeListNode::GetPred() .

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

◆  StereoMergeImages()

Bool StereoMergeImages ( BaseBitmap dest ,
const BaseBitmap *const *  source ,
Int32   cnt ,
const BaseContainer settings ,
COLORSPACETRANSFORMATION   transform  
)

Merges stereoscopic images for rendering.

参数
[out] dest The destination bitmap to be filled with the merged stereoscopic image. The caller owns the pointed bitmap.
[in] source An array containing the stereoscopic images.
[in] cnt The number of stereoscopic images in source .
[in] settings The stereoscopic render settings. See RDATA_STEREO .
[in] transform The color space transformation mode: COLORSPACETRANSFORMATION
返回
true if the stereo images were merged, otherwise false .

◆  StereoGetCameraCountEditor()

Int32 StereoGetCameraCountEditor ( BaseDocument doc ,
BaseDraw bd  
)

Retrieves the number of stereoscopic editor cameras.

参数
[in] doc The current document. The caller owns the pointed document.
[in] bd The current view. The caller owns the pointed view.
返回
The number of stereoscopic cameras.

◆  StereoGetCameraCountRenderer()

Int32 StereoGetCameraCountRenderer ( BaseDocument doc ,
RenderData rd  
)

Retrieves the number of stereoscopic cameras used for rendering.

参数
[in] doc The current document. The caller owns the pointed document.
[in] rd The current render settings. The caller owns the pointed render settings.
返回
The number of stereoscopic cameras.

◆  StereoGetCameraInfo()

Bool StereoGetCameraInfo ( BaseDocument doc ,
BaseDraw bd ,
RenderData rd ,
Int32   index ,
StereoCameraInfo info  
)

Retrieves the information structure for a stereoscopic camera.

参数
[in] doc The current document. The caller owns the pointed document.
[in] bd The current view. The caller owns the pointed view.
[in] rd The current render settings. The caller owns the pointed render settings.
[in] index The index of the stereoscopic camera: 0 <= index < StereoGetCameraCountRenderer()
[out] info Filled with the stereoscopic camera information.
返回
true if the stereoscopic camera information was retrieved, otherwise false .

◆  RenderEngineCheck()

Bool RenderEngineCheck ( Int32   id )

Checks if a videopost is available for a certain render engine.

参数
[in] id The ID of the render engine.
返回
true if the videopost is available for the specified render engine, otherwise false .