DocumentPref Class Reference

#include <c4d_documentpref.h>

Inheritance diagram for DocumentPref:

Public Member Functions

 DocumentPref ()
 
virtual Bool Write (HyperFile *hf)
 
virtual Bool Read (HyperFile *hf, Int32 id, Int32 level)
 
Float GetLOD ()
 
Bool GetRenderLod ()
 
Int32 GetFps ()
 
BaseTime GetMinTime ()
 
BaseTime GetMaxTime ()
 
BaseTime GetLoopMinTime ()
 
BaseTime GetLoopMaxTime ()
 
void SetLOD (Float lod, BaseDocument *doc)
 
void SetRenderLod (Bool lod, BaseDocument *doc)
 
void SetFps (Int32 newfps, BaseDocument *doc)
 
void SetMinTime (const BaseTime &new_min, BaseDocument *doc)
 
void SetMaxTime (const BaseTime &new_max, BaseDocument *doc)
 
void SetLoopMinTime (const BaseTime &new_min, BaseDocument *doc)
 
void SetLoopMaxTime (const BaseTime &new_max, BaseDocument *doc)
 
- Public Member Functions inherited from GeListNode
virtual Bool IsInstanceOf (cineware::Int32 id) const
 
 GeListNode ()
 
 ~GeListNode ()
 
virtual Bool HandleSubChunk (HyperFile *hf, Int32 id, Int32 level)
 
virtual Bool IsBaseList ()
 
virtual Bool GetNBit (Int32 bit) const
 
virtual Bool ChangeNBit (NBIT bit, NBITCONTROL bitmode)
 
BaseDocumentGetDocument ()
 
virtual Int32 GetInfo ()
 
virtual Int32 GetDiskType () const
 
GeListNodeGetPred ()
 
GeListNodeGetNext ()
 
GeListNodeGetUp ()
 
GeListNodeGetDown ()
 
GeListNodeGetDownLast ()
 
void InsertBefore (GeListNode *op)
 
void InsertAfter (GeListNode *op)
 
void Remove ()
 
void InsertUnder (GeListNode *op)
 
void InsertUnderLast (GeListNode *op)
 
RootList2DGetListHead ()
 
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 ()
 
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 ()
 

Private Attributes

Float d_lod
 
Int32 d_fps
 
BaseTime d_min
 
BaseTime d_max
 
BaseTime d_loop_min
 
BaseTime d_loop_max
 
Bool d_renderlod
 
Bool use_animation
 
Bool use_expressions
 
Bool use_generators
 
Bool use_deformers
 

Friends

class BaseDocument
 

Additional Inherited Members

- Public Types inherited from GeListNode
typedef PrivateChunk SUPER
 
- Protected Member Functions inherited from GeListNode
virtual Bool CopyToX (PrivateChunk *dest, COPYFLAGS flags, AliasTrans *trans)
 
virtual GeListNodeGetClone (COPYFLAGS flags, AliasTrans *trans)
 
virtual Bool TranslateDescID (const DescID &id, DescID &res_id, GeListNode *&res_at)
 
- Protected Attributes inherited from GeListNode
GeAliasGoal m_xgoal
 
UInt32 m_bits [4]
 
RootList2Dt_rootlist_parent
 
RootList2Dm_children
 
BaseDocumentparent_doc
 
void * unknownData
 
Int unknownDataSize
 
Int32 unknownDataLevel
 
Int32 pluginID
 

Detailed Description

Access document preferences.

Constructor & Destructor Documentation

◆ DocumentPref()

Default constructor.

Member Function Documentation

◆ Write()

virtual Bool Write ( HyperFile hf)
virtual

Private.

Reimplemented from GeListNode.

◆ Read()

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

Private.

◆ GetLOD()

Float GetLOD ( )

Gets the Level Of Detail.

Returns
The Level Of Detail. The default LOD values are:
  • Low = 0.25
  • Medium = 0.5
  • High = 1.0

◆ GetRenderLod()

Bool GetRenderLod ( )

Checks if the Level Of Detail for rendering should be used in the editor.

Returns
true if using the render LOD, otherwise false.

◆ GetFps()

Int32 GetFps ( )

Gets the number of Frames Per Second.

Returns
The number of FPS.

◆ GetMinTime()

BaseTime GetMinTime ( )

Gets the start time.

See also
BaseTime for conversion of FPS or other time units. GetFps()
Returns
The minimum time of the document.

◆ GetMaxTime()

BaseTime GetMaxTime ( )

Gets the end time.

See also
BaseTime for conversion of FPS or other time units. GetFps()
Returns
The maximum time of the document.

◆ GetLoopMinTime()

BaseTime GetLoopMinTime ( )

Gets the time of the left boundary for the preview range (loop range).

See also
BaseTime for conversion of FPS or other time units. GetFps()
Returns
The minimum time of the document's loop.

◆ GetLoopMaxTime()

BaseTime GetLoopMaxTime ( )

Gets the time of the right boundary for the preview range (loop range).

See also
BaseTime for conversion of FPS or other time units. GetFps()
Returns
The maximum time of the document's loop.

◆ SetLOD()

void SetLOD ( Float  lod,
BaseDocument doc 
)

Sets the Level Of Detail.

Parameters
[in]lodThe Level Of Detail. The default LOD values are:
  • Low = 0.25
  • Medium = 0.5
  • High = 1.0
[in]docThe document.

◆ SetRenderLod()

void SetRenderLod ( Bool  lod,
BaseDocument doc 
)

Sets if the Level Of Detail for rendering should be used in the editor.

Parameters
[in]lodtrue if the render LOD should be used, otherwise false.
[in]docThe document.

◆ SetFps()

void SetFps ( Int32  newfps,
BaseDocument doc 
)

Sets the number of Frames Per Second.

Parameters
[in]newfpsThe number of FPS.
[in]docThe document.

◆ SetMinTime()

void SetMinTime ( const BaseTime new_min,
BaseDocument doc 
)

Sets the start time.

See also
BaseTime for conversion of FPS or other time units. GetFps()
Parameters
[in]new_minThe minimum time.
[in]docThe document.

◆ SetMaxTime()

void SetMaxTime ( const BaseTime new_max,
BaseDocument doc 
)

Sets the end time.

See also
BaseTime for conversion of FPS or other time units. GetFps()
Parameters
[in]new_maxThe maximum time.
[in]docThe document.

◆ SetLoopMinTime()

void SetLoopMinTime ( const BaseTime new_min,
BaseDocument doc 
)

Sets the time of the left boundary for the preview range (loop range).

See also
BaseTime for conversion of FPS or other time units. GetFps()
Parameters
[in]new_minThe minimum time of the document's loop.
[in]docThe document.

◆ SetLoopMaxTime()

void SetLoopMaxTime ( const BaseTime new_max,
BaseDocument doc 
)

Sets the time of the right boundary for the preview range (loop range).

See also
BaseTime for conversion of FPS or other time units. GetFps()
Parameters
[in]new_maxThe maximum time of the document's loop.
[in]docThe document.

Friends And Related Function Documentation

◆ BaseDocument

friend class BaseDocument
friend

Member Data Documentation

◆ d_lod

Float d_lod
private

◆ d_fps

Int32 d_fps
private

◆ d_min

BaseTime d_min
private

◆ d_max

BaseTime d_max
private

◆ d_loop_min

BaseTime d_loop_min
private

◆ d_loop_max

BaseTime d_loop_max
private

◆ d_renderlod

Bool d_renderlod
private

◆ use_animation

Bool use_animation
private

◆ use_expressions

Bool use_expressions
private

◆ use_generators

Bool use_generators
private

◆ use_deformers

Bool use_deformers
private