About

A VoronoiFracture object represents a Voronoi Fracture MoGraph generator. The class provides safe access to the point sources referenced, owned and used by the generator. It is defined in the lib_voronoifracture.h header file.

// This example creates a Voronoi Fracture object,
// adds an input Sphere object, a Rigid Body tag and a point generator.
// create Voronoi Fracture object
VoronoiFracture* const fractureObject = VoronoiFracture::Alloc();
if (fractureObject == nullptr)
return maxon::OutOfMemoryError(MAXON_SOURCE_LOCATION);
doc->InsertObject(fractureObject, nullptr, nullptr);
// add a Rigid Body tag (ID 180000102)
BaseTag* const rigidBodyTag = BaseTag::Alloc(180000102);
if (rigidBodyTag == nullptr)
return maxon::OutOfMemoryError(MAXON_SOURCE_LOCATION);
fractureObject->InsertTag(rigidBodyTag);
rigidBodyTag->Message(MSG_MENUPREPARE);
// add sphere as input object
if (sphere == nullptr)
return maxon::OutOfMemoryError(MAXON_SOURCE_LOCATION);
doc->InsertObject(sphere, fractureObject, nullptr);
// add point source
BaseObject* const pointGenerator = fractureObject->AddPointGenerator(pointCreatorType, NOTOK, nullptr);
if (pointGenerator == nullptr)
return maxon::OutOfMemoryError(MAXON_SOURCE_LOCATION);
// configure point generator

Access

A VoronoiFracture object can be accessed like any other object.

// This example accesses the currently selected
// Voronoi Fracture object to print the number
// of used sources.
BaseObject* const obj = doc->GetActiveObject();
// check if the active object is a Voronoi Fracture object (ID 1036557)
if (obj != nullptr && obj->IsInstanceOf(1036557))
{
VoronoiFracture* const voronoiFracture = static_cast<VoronoiFracture*>(obj);
// get source count
const Int32 srcCnt = voronoiFracture->GetSourcesCount();
// print source count
const String srcCntStr = String::IntToString(srcCnt);
ApplicationOutput(voronoiFracture->GetName() + " uses " + srcCntStr + " sources.");
}

Allocation/Deallocation

VoronoiFracture objects are created with the usual tools:

// This example creates a Voronoi Fracture object as the new
// parent object of the currently active object.
// get active object
BaseObject* const activeObject = doc->GetActiveObject();
if (activeObject == nullptr)
return maxon::IllegalArgumentError(MAXON_SOURCE_LOCATION);
// create voronoi fracture
if (fracture == nullptr)
return maxon::OutOfMemoryError(MAXON_SOURCE_LOCATION);
// insert voronoi fracture
doc->InsertObject(fracture, nullptr, nullptr);
// insert active object under the fracture object
activeObject->Remove();
doc->InsertObject(activeObject, fracture, nullptr);

Parameters

The IDs of the standard parameters of a VoronoiFracture object are defined in the omograph_fracturevoronoi.h header file.

Note
The list of point sources must only be edited through the dedicated functions of the VoronoiFracture class (see below).

Sources

Both scene objects and dedicated point generator objects can be used to define the position of Voronoi points inside the mesh volume. The following functions allow to add, remove and edit these point sources. The type ID of point generator objects is Ovoronoipointgenerator.

Access Sources

The VoronoiFracture class provides functions to access the object and generator sources referenced in the "Sources" parameter.

// This example loops through all point sources of the given
// Voronoi Fracture object and prints their names.
// get source count
const Int32 srcCnt = voronoiFracture->GetSourcesCount();
// loop through all sources
for (Int32 i = 0; i < srcCnt; ++i)
{
// get source
BaseObject* const source = voronoiFracture->GetSource(i);
if (source == nullptr)
return maxon::UnexpectedError(MAXON_SOURCE_LOCATION);
// print source name
const String sourceName = source->GetName();
ApplicationOutput("Source: " + sourceName);
}

Remove Sources

The VoronoiFracture class also provides functions to safely remove objects and generators from the "Sources" parameter.

// This example removes all point generator sources from the
// given Voronoi Fracture object.
Int32 index = NOTOK;
// loop through all point generators until no point generator is found anymore
while (voronoiFracture->GetSourceByType(Ovoronoipointgenerator, NOTOK, &index))
{
voronoiFracture->RemoveSource(index);
}

Add Sources

Using the VoronoiFracture functions it is safe to add new sources and generators to the "Sources" parameter.

Point generators are represented by dedicated BaseObject elements that are owned by the VoronoiFracture object. To configure such a point generator one can simply edit the parameters of the corresponding BaseObject. The parameter IDs of these parameters are defined in opointcreator_panel.h.

// This example adds a shader generator source to the given
// Voronoi Fracture object and adds a shader.
const Int32 shaderGenerator = ID_POINTCREATOR_CREATORTYPE_SHADER;
BaseObject* const shaderSource = voronoiFracture->AddPointGenerator(shaderGenerator, Xnoise);
if (shaderSource == nullptr)
return maxon::UnknownError(MAXON_SOURCE_LOCATION);
// configure generator

The VoronoiFracture object can also use external objects as sources of points:

The IDs for these settings are defined in tfracturevoronoi.h.

// This example creates a new cube and uses it
// as a point source in the given VoronoiFracture object.
if (cube == nullptr)
return maxon::OutOfMemoryError(MAXON_SOURCE_LOCATION);
doc->InsertObject(cube, nullptr, nullptr);
// use as source object
voronoiFracture->AddSceneObject(cube);
BaseContainer* const settings = voronoiFracture->GetSourceSettingsContainerForObject(cube);
if (settings == nullptr)
return maxon::UnknownError(MAXON_SOURCE_LOCATION);

Further Reading

BaseTag::Alloc
static BaseTag * Alloc(Int32 type)
VoronoiFracture::AddPointGenerator
BaseObject * AddPointGenerator(const Int32 type, const Int32 shaderType=NOTOK, Int32 *const index=nullptr)
ID_FRACTURETAG_POINTCREATIONTYPE
@ ID_FRACTURETAG_POINTCREATIONTYPE
Definition: tfracturevoronoi.h:15
BaseDocument::InsertObject
void InsertObject(BaseObject *op, BaseObject *parent, BaseObject *pred, Bool checknames=false)
VoronoiFracture::Alloc
static VoronoiFracture * Alloc()
BaseObject
Definition: c4d_baseobject.h:224
BaseContainer::SetInt32
void SetInt32(Int32 id, Int32 l)
Definition: c4d_basecontainer.h:505
Ovoronoipointgenerator
#define Ovoronoipointgenerator
Voronoi Fracture internal Point generator.
Definition: ge_prepass.h:1097
BaseTag
Definition: c4d_basetag.h:46
Ocube
#define Ocube
Cube.
Definition: ge_prepass.h:1047
MAXON_SOURCE_LOCATION
#define MAXON_SOURCE_LOCATION
Definition: memoryallocationbase.h:66
DESCFLAGS_SET::NONE
@ NONE
None.
Xnoise
#define Xnoise
Noise.
Definition: ge_prepass.h:1207
ID_POINTCREATOR_CREATORTYPE_SHADER
@ ID_POINTCREATOR_CREATORTYPE_SHADER
Definition: opointcreator_panel.h:8
Osphere
#define Osphere
Sphere.
Definition: ge_prepass.h:1048
ID_POINTCREATOR_SHADERSAMPLEAMOUNT
@ ID_POINTCREATOR_SHADERSAMPLEAMOUNT
Definition: opointcreator_panel.h:44
String
Definition: c4d_string.h:38
VoronoiFracture::GetSourceByType
BaseObject * GetSourceByType(const Int32 type, const Int32 startIndex=NOTOK, Int32 *const index=nullptr)
String::IntToString
static String IntToString(Int32 v)
Definition: c4d_string.h:495
C4DAtom::SetParameter
Bool SetParameter(const DescID &id, const GeData &t_data, DESCFLAGS_SET flags)
VoronoiFracture::GetSourcesCount
Int32 GetSourcesCount()
MSG_MENUPREPARE
#define MSG_MENUPREPARE
Allows tags, objects, shaders etc. to do some setup work when called from the menu....
Definition: c4d_baselist.h:384
NOTOK
#define NOTOK
Definition: ge_sys_math.h:267
VoronoiFracture
Definition: lib_voronoifracture.h:25
Int32
maxon::Int32 Int32
Definition: ge_sys_math.h:60
ApplicationOutput
#define ApplicationOutput(formatString,...)
Definition: debugdiagnostics.h:208
C4DAtom::Message
Bool Message(Int32 type, void *data=nullptr)
Definition: c4d_baselist.h:1424
GeListNode::Remove
void Remove()
Definition: c4d_baselist.h:1884
ID_POINTCREATOR_CREATORTYPE_DISTRIBUTION
@ ID_POINTCREATOR_CREATORTYPE_DISTRIBUTION
Definition: opointcreator_panel.h:7
VoronoiFracture::GetSource
BaseObject * GetSource(const Int32 index)
BaseObject::Alloc
static BaseObject * Alloc(Int32 type)
VoronoiFracture::AddSceneObject
Bool AddSceneObject(BaseObject *object, Int32 *const index=nullptr)
VoronoiFracture::RemoveSource
Bool RemoveSource(const Int32 index)
BaseDocument::GetActiveObject
BaseObject * GetActiveObject(void)
C4DAtom::IsInstanceOf
Bool IsInstanceOf(Int32 id) const
Definition: c4d_baselist.h:1403
BaseList2D::GetName
String GetName() const
Definition: c4d_baselist.h:2348
ID_POINTCREATOR_CREATEDPOINTAMOUNT
@ ID_POINTCREATOR_CREATEDPOINTAMOUNT
Definition: opointcreator_panel.h:25
BaseObject::InsertTag
void InsertTag(BaseTag *tp, BaseTag *pred=nullptr)
BaseContainer
Definition: c4d_basecontainer.h:46
VoronoiFracture::GetSourceSettingsContainerForObject
BaseContainer * GetSourceSettingsContainerForObject(BaseObject *object)
ID_FRACTURETAG_POLYS
@ ID_FRACTURETAG_POLYS
Definition: tfracturevoronoi.h:18