VoronoiFracture Class Reference

#include <lib_voronoifracture.h>

Inheritance diagram for VoronoiFracture:

Detailed Description

Voronoi Fracture object.

Since
R18

Private Member Functions

 VoronoiFracture ()
 
 ~VoronoiFracture ()
 

Alloc/Free

static VoronoiFractureAlloc ()
 
static void Free (VoronoiFracture *&fracture)
 

Operations

Int32 GetSourcesCount ()
 
BaseObjectGetSource (const Int32 index)
 
BaseObjectGetSourceByType (const Int32 type, const Int32 startIndex=NOTOK, Int32 *const index=nullptr)
 
Bool RemoveSource (const Int32 index)
 
BaseObjectAddPointGenerator (const Int32 type, const Int32 shaderType=NOTOK, Int32 *const index=nullptr)
 
Bool AddSceneObject (BaseObject *object, Int32 *const index=nullptr)
 
void ClearSources ()
 
BaseContainerGetSourceSettingsContainerForIndex (const Int32 index)
 
BaseContainerGetSourceSettingsContainerForObject (BaseObject *object)
 

Additional Inherited Members

- Public Member Functions inherited from BaseObject
BaseObjectGetNext (void)
 
BaseObjectGetPred (void)
 
BaseObjectGetUp (void)
 
BaseObjectGetDown (void)
 
BaseObjectGetDownLast (void)
 
Vector GetAbsPos () const
 
void SetAbsPos (const Vector &v)
 
Vector GetAbsScale () const
 
void SetAbsScale (const Vector &v)
 
Vector GetAbsRot () const
 
void SetAbsRot (const Vector &v)
 
Vector GetFrozenPos () const
 
void SetFrozenPos (const Vector &v)
 
Vector GetFrozenScale () const
 
void SetFrozenScale (const Vector &v)
 
Vector GetFrozenRot () const
 
void SetFrozenRot (const Vector &v)
 
Vector GetRelPos () const
 
void SetRelPos (const Vector &v)
 
Vector GetRelScale () const
 
void SetRelScale (const Vector &v)
 
Vector GetRelRot () const
 
void SetRelRot (const Vector &v)
 
const MatrixGetMl (void) const
 
void SetMl (const Matrix &m)
 
Matrix GetFrozenMln () const
 
Matrix GetRelMln () const
 
Matrix GetRelMl () const
 
void SetRelMl (const Matrix &m)
 
Matrix GetMg () const
 
void SetMg (const Matrix &m)
 
Matrix GetMln () const
 
Matrix GetMgn () const
 
Matrix GetUpMg () const
 
void CopyMatrixTo (BaseObject *dst)
 
Vector GetMp (void)
 
Vector GetRad (void)
 
Int32 GetEditorMode (void)
 
void SetEditorMode (Int32 mode)
 
Int32 GetRenderMode (void)
 
void SetRenderMode (Int32 mode)
 
Bool GetDeformMode (void)
 
void SetDeformMode (Bool mode)
 
Int32 GetUniqueIP (void)
 
void SetUniqueIP (Int32 ip)
 
BaseTagGetFirstTag (void)
 
BaseTagGetLastTag (void)
 
BaseTagGetTag (Int32 type, Int32 nr=0)
 
const void * GetTagDataR (Int32 type, Int32 nr=0) const
 
void * GetTagDataW (Int32 type, Int32 nr=0)
 
Int32 GetTagDataCount (Int32 type) const
 
BaseTagMakeTag (Int32 type, BaseTag *pred=nullptr)
 
VariableTagMakeVariableTag (Int32 type, Int32 count, BaseTag *pred=nullptr)
 
void InsertTag (BaseTag *tp, BaseTag *pred=nullptr)
 
void KillTag (Int32 type, Int32 nr=0)
 
Bool CopyTagsTo (BaseObject *dest, Int32 visible, Int32 variable, Int32 hierarchical, AliasTrans *trans)
 
BaseObjectGetCache (HierarchyHelp *hh=nullptr)
 
BaseObjectGetDeformCache (void)
 
LineObjectGetIsoparm (void)
 
void SetIsoparm (LineObject *l)
 
BaseObjectGetCacheParent (void)
 
Bool SetPhong (Bool on, Bool anglelimit, Float angle)
 
Bool IsDirty (DIRTYFLAGS flags)
 
void SetDirty (DIRTYFLAGS flags)
 
Bool CheckCache (HierarchyHelp *hh)
 
void Touch (void)
 
void GetColorProperties (ObjectColorProperties *prop)
 
void SetColorProperties (ObjectColorProperties *prop)
 
const MatrixGetModelingAxis (BaseDocument *doc)
 
void SetModelingAxis (const Matrix &m)
 
BaseObjectGetAndCheckHierarchyClone (HierarchyHelp *hh, BaseObject *op, HIERARCHYCLONEFLAGS flags, Bool *dirty, AliasTrans *trans, Bool allchildren)
 
BaseObjectGetHierarchyClone (HierarchyHelp *hh, BaseObject *op, HIERARCHYCLONEFLAGS flags, Bool *dirty, AliasTrans *trans)
 
BaseObjectGetHierarchyClone (HierarchyHelp *hh, BaseObject *op, HIERARCHYCLONEFLAGS flags, Bool *dirty, AliasTrans *trans, DIRTYFLAGS dirtyflags)
 
void NewDependenceList (void)
 
Bool CompareDependenceList (void)
 
void AddDependence (HierarchyHelp *hh, BaseObject *op)
 
void AddDependence (HierarchyHelp *hh, BaseObject *op, DIRTYFLAGS dirtyflags)
 
void TouchDependenceList (void)
 
void SetRotationOrder (ROTATIONORDER order)
 
ROTATIONORDER GetRotationOrder (void) const
 
void SetQuaternionRotationMode (Bool active, Bool bUndo)
 
Bool IsQuaternionRotationMode (void)
 
Bool SynchronizeVectorTrackKeys (Int32 vectorTrackID, Bool bUndo, BaseTime startRange=BaseTime(-108000, 1), BaseTime endRange=BaseTime(108000, 1))
 
Bool FindBestEulerAngle (Int32 rotationTrackID, Bool bAdjustTangent, Bool bUndo, BaseTime startRange=BaseTime(-108000, 1), BaseTime endRange=BaseTime(108000, 1))
 
Bool EvaluateSynchronizedRotation (const BaseTime &time, ANIMATEFLAGS flags, Vector *resultRotation=nullptr)
 
Bool GetVectorTracks (const DescID &id, CTrack *&xfound, CTrack *&yfound, CTrack *&zfound)
 
Bool GetVectorCurves (CCurve *curveToSearch, CCurve *&xfound, CCurve *&yfound, CCurve *&zfound)
 
UInt64 GetGUID ()
 
Int32 GetHighlightHandle (BaseDraw *bd)
 
SplineObjectGetRealSpline (void)
 
Float GetVisibility (Float parent)
 
Bool SearchHierarchy (BaseObject *op)
 
BaseObjectGetOrigin (Bool safe)
 
void SetOrigin (BaseObject *origin)
 
BaseObjectGetTopOrigin (Bool parent, Bool safe)
 
BaseObjectGetEditObject (BaseObject **psds, DISPLAYEDITSTATE state)
 
void RemoveFromCache (void)
 
- 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 BaseObject
static BaseObjectAlloc (Int32 type)
 
static void Free (BaseObject *&bl)
 
- Static Public Member Functions inherited from BaseList2D
static BaseList2DAlloc (Int32 type)
 
static void Free (BaseList2D *&bl)
 

Constructor & Destructor Documentation

§ VoronoiFracture()

VoronoiFracture ( )
private

§ ~VoronoiFracture()

~VoronoiFracture ( )
private

Member Function Documentation

§ Alloc()

static VoronoiFracture* Alloc ( )
static

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

Returns
The allocated VoronoiFracture object, or nullptr if the allocation failed.

§ Free()

static void Free ( VoronoiFracture *&  fracture)
static

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

Parameters
[in]fractureThe VoronoiFracture object to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

§ GetSourcesCount()

Int32 GetSourcesCount ( )

Returns the number of elements in the "Sources" list, including point generators.

Returns
The number of elements in the "Sources" list.

§ GetSource()

BaseObject* GetSource ( const Int32  index)

Retrieves the object referenced at the given index.

Note
If index references a point generator that point generator object is returned.
Parameters
[in]indexThe index of the source element to access.
Returns
The object at the given index or nullptr.

§ GetSourceByType()

BaseObject* GetSourceByType ( const Int32  type,
const Int32  startIndex = NOTOK,
Int32 *const  index = nullptr 
)

Retrieves the object referenced in the "Sources" list with the given type.

Note
If multiple objects with the given type exist the first is returned.
Parameters
[in]typeThe type of object to access.
[in]startIndexStart search at index.
[out]indexThe index of the returned object.
Returns
The found object.

§ RemoveSource()

Bool RemoveSource ( const Int32  index)

Removes the source element in the list at the given index.

Note
If the index references a point generator it is also deleted from the internal list.
Parameters
[in]indexThe index of the source element to remove.
Returns
true if the element was removed successfully, otherwise false.

§ AddPointGenerator()

BaseObject* AddPointGenerator ( const Int32  type,
const Int32  shaderType = NOTOK,
Int32 *const  index = nullptr 
)

Adds a new point generator.

Parameters
[in]typeThe type of point generator, either ID_POINTCREATOR_CREATORTYPE_DISTRIBUTION or ID_POINTCREATOR_CREATORTYPE_SHADER.
[in]shaderTypeIf a "Shader" generator is created a shader of this type is automatically added to it. Pass NOTOK if the parameter should be ignored.
[out]indexThe index of the newly created point generator.
Returns
The created point generator. The Fracture object owns the pointed object.

§ AddSceneObject()

Bool AddSceneObject ( BaseObject object,
Int32 *const  index = nullptr 
)

Adds a valid object from the scene to the "Sources" list.

Parameters
[in]objectThe object that should be added to the Fracture object's "Sources" list.
[out]indexThe index of the newly added object.
Returns
true if the object was added successfully, otherwise false.

§ ClearSources()

void ClearSources ( )

Clears the "Sources" list and deletes all point generators.

§ GetSourceSettingsContainerForIndex()

BaseContainer* GetSourceSettingsContainerForIndex ( const Int32  index)

Returns the internal container for the settings of an external source input, like a polygon object as point source.

Since
R19
Note
Allows to change the settings that control for example the distribution of points in the object and the point count.
Parameters
[in]indexThe index of the object in the Sources list.
Returns
The container for the source settings if the index fits to an external Source input, otherwise nullptr. The VoronoiFracture owns the pointed BaseContainer.

§ GetSourceSettingsContainerForObject()

BaseContainer* GetSourceSettingsContainerForObject ( BaseObject object)

Returns the internal container for the settings of an external source input, like a polygon object as point source.

Since
R19
Note
Allows to change the settings that control for example the distribution of points in the object and the point count.
Parameters
[in]objectThe external source object in the Sources list. The caller owns the pointed BaseObject.
Returns
The container for the source settings if the object is in the Sources list, otherwise nullptr. The VoronoiFracture owns the pointed BaseContainer.