BaseSettings Class Referenceabstract

#include <c4d_basesettings.h>

Inheritance diagram for BaseSettings:

Public Member Functions

virtual Bool Read (HyperFile *hf, Int32 id, Int32 level)
 
virtual Bool Write (HyperFile *hf)
 
virtual Bool Init ()
 
virtual void Free ()
 
Bool Copy (BaseSettings *dest)
 
virtual Bool BS_Init ()=0
 
virtual void BS_Free ()=0
 
virtual Bool BS_CopyTo (BaseSettings *dest)=0
 
virtual Bool BS_ReadfromContainer (BaseContainer *bc, BaseDocument *doc)=0
 
virtual Bool BS_WriteToContainer (BaseContainer *bc, BaseDocument *doc)=0
 
- Public Member Functions inherited from NodeData
virtual Bool IsInstanceOf (cineware::Int32 id) const
 
 NodeData ()
 
BaseList2DGetNode ()
 
void SetNode (BaseList2D *ptr)
 
BaseTagGetTag (Int32 id)
 
BaseTagMakeTag (Int32 id)
 
- Public Member Functions inherited from PrivateChunk
 PrivateChunk ()
 
Bool ReadChunk (HyperFile *hf, Bool keepin=false, Bool noheader=false)
 
virtual Bool IsListHead ()
 
virtual Int32 GetType () const
 
virtual Int32 GetInstanceType () const
 
Bool ReadObject (HyperFile *hf, Bool readheader)
 
Bool WriteObject (HyperFile *hf, Int32 type)
 
Bool CopyTo (PrivateChunk *dest, COPYFLAGS flags, AliasTrans *trans)
 
virtual Bool GetDParameter (const DescID &id, GeData &data)
 
virtual Bool SetDParameter (const DescID &id, const GeData &data)
 
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 >
PrivateChunkGetNext () const
 
PrivateChunkGetPrev () const
 
void InsertBefore (PrivateChunk *n)
 
void InsertAfter (PrivateChunk *n)
 
void Remove ()
 

Public Attributes

Int32 b_type
 
Bool initialised
 
String search_original
 
String search_lowercase
 
Int32 iconsize
 
Bool show_filter
 
Bool show_source
 
Bool show_path
 
Bool show_find
 
BaseContainer weights
 
Bool auto_h
 

Additional Inherited Members

- Public Types inherited from NodeData
typedef PrivateChunk SUPER
 
- Protected Member Functions inherited from NodeData
virtual Bool Execute ()
 
virtual Int32 GetDiskType () const
 
virtual Bool CopyToX (PrivateChunk *dst, COPYFLAGS flags, AliasTrans *trans)
 
virtual Bool TranslateDescID (GeListNode *node, const DescID &id, DescID &res_id, GeListNode *&res_at)
 
- Protected Member Functions inherited from PrivateChunk
virtual Bool HandleSubChunk (HyperFile *hf, Int32 id, Int32 level)
 

Detailed Description

Private.

Member Function Documentation

◆ Read()

virtual Bool Read ( HyperFile hf,
Int32  id,
Int32  level 
)
virtual

Reads the node from a hyper file.

Parameters
[in]hfThe hyper file to read from. Cineware SDK owns the pointed hyper file.
[in]idThe ID of the node to read.
[in]levelThe disklevel of the node to read.
Returns
true if successful, otherwise false.

Reimplemented from NodeData.

◆ Write()

virtual Bool Write ( HyperFile hf)
virtual

Reimplemented from PrivateChunk.

◆ Init()

virtual Bool Init ( )
virtual

Called when an instance of a derived node data class needs to be initialized.

Returns
true if successful, otherwise false.

Reimplemented from NodeData.

◆ Free()

virtual void Free ( )
virtual

Reimplemented from NodeData.

◆ Copy()

Bool Copy ( BaseSettings dest)

◆ BS_Init()

virtual Bool BS_Init ( )
pure virtual

Implemented in TLSettings, and OMSettings.

◆ BS_Free()

virtual void BS_Free ( )
pure virtual

Implemented in TLSettings, and OMSettings.

◆ BS_CopyTo()

virtual Bool BS_CopyTo ( BaseSettings dest)
pure virtual

Implemented in TLSettings, and OMSettings.

◆ BS_ReadfromContainer()

virtual Bool BS_ReadfromContainer ( BaseContainer bc,
BaseDocument doc 
)
pure virtual

Implemented in TLSettings, and OMSettings.

◆ BS_WriteToContainer()

virtual Bool BS_WriteToContainer ( BaseContainer bc,
BaseDocument doc 
)
pure virtual

Implemented in TLSettings, and OMSettings.

Member Data Documentation

◆ b_type

Int32 b_type

◆ initialised

Bool initialised

◆ search_original

String search_original

◆ search_lowercase

String search_lowercase

◆ iconsize

Int32 iconsize

◆ show_filter

Bool show_filter

◆ show_source

Bool show_source

◆ show_path

Bool show_path

◆ show_find

Bool show_find

◆ weights

BaseContainer weights

◆ auto_h

Bool auto_h