BaseVideoPost Class Reference

#include <c4d_basevideopost.h>

Inheritance diagram for BaseVideoPost:

Public Types
typedef BaseList2D	SUPER
Public Types inherited from BaseList2D
typedef GeListNode	SUPER
Public Types inherited from GeListNode
typedef PrivateChunk	SUPER

Public Member Functions
virtual Bool	IsInstanceOf (cineware::Int32 id) const
Public Member Functions inherited from BaseList2D
	BaseList2D ()
virtual	~BaseList2D ()
BaseList2D *	GetNext ()
BaseList2D *	GetPred ()
NodeData *	GetNodeData ()
void	SetNodeData (NodeData *data)
void	SetBit (Int32 mask)
Bool	GetBit (Int32 mask)
void	DelBit (Int32 mask)
void	ToggleBit (Int32 mask)
Int32	GetAllBits ()
void	SetAllBits (Int32 bits)
BaseContainer	GetData ()
BaseContainer *	GetDataInstance ()
BaseContainer &	GetDataInstanceRef ()
const String &	GetName ()
void	SetName (const String &new_name)
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
BaseShader *	GetFirstShader ()
Bool	InsertShader (BaseShader *shader, BaseShader *pred=nullptr)
Bool	InsertShaderLast (BaseShader *shader)
RootCTrack *	GetCTrackRoot ()
CTrack *	GetFirstCTrack ()
CTrack *	FindCTrack (const DescID &id)
Bool	AppendCTrack (CTrack *t)
void	InsertTrackSorted (CTrack *track)
LayerObject *	GetLayerObject ()
void	SetLayerObject (LayerObject *layer)
const LayerData *	GetLayerData (BaseDocument *doc, Bool rawdata=false)
Bool	SetLayerData (BaseDocument *doc, const LayerData &data)
DynamicDescription *	GetDynamicDescription ()
virtual Bool	IsBaseList ()
virtual void	Remove ()
Bool	SetDescIDState (const DescID &id, DESCIDSTATE descidstate)
DESCIDSTATE	GetDescIDState (const DescID &id, Bool tolerant) const
RootPluginNode *	GetOverrideRoot ()
BaseOverride *	GetFirstOverride ()
virtual Bool	TranslateDescID (const DescID &id, DescID &res_id, GeListNode *&res_at)
Public Member Functions inherited from GeListNode
	GeListNode ()
	~GeListNode ()
virtual Bool	GetNBit (Int32 bit) const
virtual Bool	ChangeNBit (NBIT bit, NBITCONTROL bitmode)
BaseDocument *	GetDocument ()
virtual Int32	GetInfo ()
GeListNode *	GetPred ()
GeListNode *	GetNext ()
GeListNode *	GetUp ()
GeListNode *	GetDown ()
GeListNode *	GetDownLast ()
void	InsertBefore (GeListNode *op)
void	InsertAfter (GeListNode *op)
void	Remove ()
void	InsertUnder (GeListNode *op)
void	InsertUnderLast (GeListNode *op)
RootList2D *	GetListHead ()
Int32	GetNodeID (Int32 index=0) const
Public Member Functions inherited from PrivateChunk
	PrivateChunk ()
Bool	ReadChunk (HyperFile *hf, Bool keepin=false, Bool noheader=false)
virtual Bool	IsListHead ()
Bool	ReadObject (HyperFile *hf, Bool readheader)
Bool	WriteObject (HyperFile *hf, Int32 type)
Bool	CopyTo (PrivateChunk *dest, COPYFLAGS flags, AliasTrans *trans)
Bool	GetParameter (Int32 id, GeData &data)
Bool	SetParameter (Int32 id, const GeData &data)
Bool	GetParameter (const DescID &id, GeData &data)
Bool	SetParameter (const DescID &id, const GeData &data)
virtual Int32	GetChunkLevel ()
Public Member Functions inherited from GeTempPublicNode2D< PrivateChunk >
PrivateChunk *	GetNext () const
PrivateChunk *	GetPrev () const
void	InsertBefore (PrivateChunk *n)
void	InsertAfter (PrivateChunk *n)
void	Remove ()

Protected Member Functions
virtual Int32	GetInstanceType () const
Protected Member Functions inherited from BaseList2D
void	SetID (Int32 id)
virtual Bool	GetDParameter (const DescID &id, GeData &data)
virtual Bool	SetDParameter (const DescID &id, const GeData &data)

Private Attributes
BaseContainer	inheritance_container
Int32	vpID

Constructor
	BaseVideoPost ()
	BaseVideoPost (Int32 id)
virtual	~BaseVideoPost ()

Alloc/Free
static BaseVideoPost *	Alloc (Int32 id)
static void	Free (BaseVideoPost *&vp)

Navigation
BaseVideoPost *	GetNext ()
BaseVideoPost *	GetPred ()

Type
virtual Int32	GetType () const
virtual Int32	GetDiskType () const

Clone
virtual BaseList2D *	GetClone (COPYFLAGS flags, AliasTrans *trans)

Private
NodeData *	AllocData (Int32 id, Bool &known)
virtual Bool	CopyToX (PrivateChunk *dst, COPYFLAGS flags, AliasTrans *trn)
virtual Bool	HandleSubChunk (HyperFile *hf, Int32 id, Int32 level)
virtual Bool	Write (HyperFile *hf)

Additional Inherited Members
Protected Attributes inherited from BaseList2D
Int32	m_id
RootShader	mp_rootshader
RootShader	mp_rootshader_hidden
RootShader	root_shader_repository
Int32	l_bitfeld
RootCTrack	mp_rootctrack
RootPluginNode	root_override
NotifyList *	notify_events
DescIdStore *	keyframestore
DescIdStore *	propstore
BaseContainer	m_bc
NodeData *	m_data
Protected Attributes inherited from GeListNode
GeAliasGoal	m_xgoal
UInt32	m_bits [4]
RootList2D *	t_rootlist_parent
RootList2D *	m_children
BaseDocument *	parent_doc
void *	unknownData
Int	unknownDataSize
Int32	unknownDataLevel
Int32	pluginID

Detailed Description

Represents a video post node.

Note

Has to be created with Alloc() and destroyed with Free().

To check if a video post node is enabled call:

Bool vpEnabled = !pvp->GetBit(BIT_VPDISABLED);

Member Typedef Documentation

SUPER

typedef BaseList2D SUPER

Constructor & Destructor Documentation

BaseVideoPost() [1/2]

BaseVideoPost

(

)

Default constructor.

BaseVideoPost() [2/2]

BaseVideoPost

(

Int32

id

)

Construct a video post of the given type id.

Parameters

[in]

id

The video post type ID.

~BaseVideoPost()

virtual ~BaseVideoPost ( )

virtual

Default destructor.

Member Function Documentation

IsInstanceOf()

virtual Bool IsInstanceOf ( cineware::Int32  id ) const

virtual

Reimplemented from BaseList2D.

GetInstanceType()

virtual Int32 GetInstanceType ( ) const

protectedvirtual

Reimplemented from BaseList2D.

Alloc()

static BaseVideoPost* Alloc ( Int32  id )

static

Allocates a video post. Destroy the allocated video post with Free().

Parameters

[in]

id

The video post type ID.

Returns

The allocated video post, or nullptr if the allocation failed.

Free()

static void Free ( BaseVideoPost *&  vp )

static

Destructs video posts allocated with Alloc().

Parameters

[in,out]

vp

The video post to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

GetNext()

BaseVideoPost* GetNext

(

)

Gets the next video post in the list.

Returns

The next video post effect, or nullptr if there is none. Cineware SDK owns the pointed video post.

GetPred()

BaseVideoPost* GetPred

(

)

Gets the previous video post in the list.

Returns

The previous video post effect, or nullptr if there is none. Cineware SDK owns the pointed video post.

GetType()

virtual Int32 GetType ( ) const

virtual

Gets the type of the video post.

Warning

This must be used to make sure that the derived tag really is of the right type before casting it and accessing its members.

Note

Plugin materials return their unique plugin IDs.

Returns

The video post type.

Reimplemented from BaseList2D.

GetDiskType()

virtual Int32 GetDiskType ( ) const

virtual

Gets the video post's unique disk type.

Note

Normally this is the same as GetType(), but there are exceptions.

Returns

The video post's unique disk type.

Reimplemented from BaseList2D.

GetClone()

virtual BaseList2D* GetClone ( COPYFLAGS  flags, AliasTrans *  trans  )

virtual

Gets a clone/copy of the video post.

Parameters

[in]	flags	Flags for the clone.
[in]	trans	An alias translator for the operation. Can be nullptr. The caller owns the pointed alias translator.

Returns

The cloned video post. The caller owns the pointed video post.

Reimplemented from BaseList2D.

AllocData()

NodeData* AllocData	(	Int32	id,
		Bool &	known
	)

Private.

CopyToX()

virtual Bool CopyToX ( PrivateChunk *  dst, COPYFLAGS  flags, AliasTrans *  trn  )

virtual

Private.

Reimplemented from BaseList2D.

HandleSubChunk()

virtual Bool HandleSubChunk ( HyperFile *  hf, Int32  id, Int32  level  )

virtual

Private.

Reimplemented from BaseList2D.

Write()

virtual Bool Write ( HyperFile *  hf )

virtual

Private.

Reimplemented from BaseList2D.

Member Data Documentation

inheritance_container

BaseContainer inheritance_container

private

vpID

Int32 vpID

private