BaseVideoPost Class Reference

#include <c4d_videopost.h>

Inheritance diagram for BaseVideoPost:

Detailed Description

Represents a videopost node.

Note
Has to be created with Alloc() and destroyed with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.

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

Private Member Functions

 BaseVideoPost ()
 
 ~BaseVideoPost ()
 

Navigation

static BaseVideoPostAlloc (Int32 type)
 
static void Free (BaseVideoPost *&bl)
 
BaseVideoPostGetNext (void)
 
BaseVideoPostGetPred (void)
 

Stereoscopic

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
BaseList2DGetNext (void)
 
BaseList2DGetPred (void)
 
void SetBit (Int32 mask)
 
Bool GetBit (Int32 mask) const
 
void DelBit (Int32 mask)
 
void ToggleBit (Int32 mask)
 
Int32 GetAllBits (void) const
 
void SetAllBits (Int32 bits)
 
BaseContainer GetData (void)
 
void SetData (const BaseContainer &bc, Bool add=true)
 
const BaseContainerGetDataInstance (void) const
 
BaseContainerGetDataInstance (void)
 
const BaseContainerGetDataInstanceRef (void) const
 
BaseContainerGetDataInstanceRef (void)
 
const StringGetName (void) const
 
void SetName (const String &name)
 
String GetBubbleHelp (void)
 
Bool TransferGoal (BaseList2D *dst, Bool undolink)
 
Bool TransferMarker (BaseList2D *dst) const
 
Bool Scale (Float scale)
 
Bool Edit (void)
 
void GetIcon (IconData *dat)
 
GeListHeadGetNLARoot (void)
 
BaseList2DAnimationLayerRemap (BaseObject **layer=nullptr)
 
const StringGetTypeName (void)
 
BaseList2DGetMain (void) 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
 
GeListHeadGetOverrideRoot (void)
 
BaseOverrideGetFirstOverride (void)
 
GeListHeadGetShaderRepositoryRoot (void)
 
void GetMarkerStampEx (UInt32 *l1, UInt32 *l2)
 
const GeMarkerGetMarker (void) 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)
 
BaseShaderGetFirstShader () const
 
void InsertShader (BaseShader *shader, BaseShader *pred=nullptr)
 
void ClearKeyframeSelection ()
 
Bool FindKeyframeSelection (const DescID &id)
 
Bool SetKeyframeSelection (const DescID &id, Bool selection)
 
Bool KeyframeSelectionContent ()
 
LayerObjectGetLayerObject (BaseDocument *doc)
 
Bool SetLayerObject (LayerObject *layer)
 
const LayerDataGetLayerData (BaseDocument *doc, Bool rawdata=false)
 
Bool SetLayerData (BaseDocument *doc, const LayerData &data)
 
GeListHeadGetCTrackRoot (void)
 
CTrackGetFirstCTrack (void)
 
CTrackFindCTrack (const DescID &id)
 
- Public Member Functions inherited from GeListNode
GeListNodeGetNext (void)
 
GeListNodeGetPred (void)
 
GeListNodeGetDown (void)
 
GeListNodeGetUp (void)
 
GeListNodeGetDownLast (void)
 
void InsertBefore (GeListNode *bl)
 
void InsertAfter (GeListNode *bl)
 
void InsertUnder (GeListNode *bl)
 
void InsertUnderLast (GeListNode *bl)
 
void Remove (void)
 
GeListHeadGetListHead (void)
 
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)
 
GeListNodeGetCustomData (void)
 
BaseDocumentGetDocument (void)
 
Int32 GetBranchInfo (BranchInfo *info, Int32 max, GETBRANCHINFO flags)
 
Bool IsDocumentRelated (void)
 
Int32 GetInfo (void)
 
Bool GetNBit (NBIT bit) const
 
Bool ChangeNBit (NBIT bit, NBITCONTROL bitmode)
 
- Public Member Functions inherited from C4DAtom
Int32 GetType (void) const
 
Int32 GetRealType (void) const
 
Int32 GetDiskType (void) const
 
Bool IsInstanceOf (Int32 id) const
 
Int32 GetClassification (void) const
 
Bool Message (Int32 type, void *data=nullptr)
 
Bool MultiMessage (MULTIMSG_ROUTE flags, Int32 type, void *data)
 
C4DAtomGetClone (COPYFLAGS flags, AliasTrans *trn)
 
Bool CopyTo (C4DAtom *dst, COPYFLAGS flags, AliasTrans *trn)
 
Bool Read (HyperFile *hf, Int32 id, Int32 level)
 
Bool Write (HyperFile *hf)
 
Bool ReadObject (HyperFile *hf, Bool readheader)
 
Bool WriteObject (HyperFile *hf)
 
Bool GetDescription (Description *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)
 
DynamicDescriptionGetDynamicDescription ()
 
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 BaseList2DAlloc (Int32 type)
 
static void Free (BaseList2D *&bl)
 

Constructor & Destructor Documentation

§ BaseVideoPost()

BaseVideoPost ( )
private

§ ~BaseVideoPost()

~BaseVideoPost ( )
private

Member Function Documentation

§ Alloc()

static BaseVideoPost* Alloc ( Int32  type)
static

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

Parameters
[in]typeThe videopost ID.
Returns
The allocated videopost, or nullptr if the allocation failed.

§ Free()

static void Free ( BaseVideoPost *&  bl)
static

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

Parameters
[in]blThe 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().

Returns
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().

Returns
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.

Parameters
[out]destThe destination bitmap to be filled with the merged stereoscopic image. The caller owns the pointed bitmap.
[in]sourceAn array containing the stereoscopic images.
[in]cntThe number of stereoscopic images in source.
[in]settingsThe stereoscopic render settings. See RDATA_STEREO.
[in]transformThe color space transformation mode: COLORSPACETRANSFORMATION
Returns
true if the stereo images were merged, otherwise false.

§ StereoGetCameraCountEditor()

Int32 StereoGetCameraCountEditor ( BaseDocument doc,
BaseDraw bd 
)

Retrieves the number of stereoscopic editor cameras.

Parameters
[in]docThe current document. The caller owns the pointed document.
[in]bdThe current view. The caller owns the pointed view.
Returns
The number of stereoscopic cameras.

§ StereoGetCameraCountRenderer()

Int32 StereoGetCameraCountRenderer ( BaseDocument doc,
RenderData rd 
)

Retrieves the number of stereoscopic cameras used for rendering.

Parameters
[in]docThe current document. The caller owns the pointed document.
[in]rdThe current render settings. The caller owns the pointed render settings.
Returns
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.

Parameters
[in]docThe current document. The caller owns the pointed document.
[in]bdThe current view. The caller owns the pointed view.
[in]rdThe current render settings. The caller owns the pointed render settings.
[in]indexThe index of the stereoscopic camera: 0 <= index < StereoGetCameraCountRenderer()
[out]infoFilled with the stereoscopic camera information.
Returns
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.

Parameters
[in]idThe ID of the render engine.
Returns
true if the videopost is available for the specified render engine, otherwise false.