关于

A VolumeBuilder is used to create a volume based on various input objects. The created volumes are represented as VolumeObject objects within the generator's cache. The VolumeBuilder class is defined in the lib_volumebuilder.h header file. The parameter IDs are defined in ovolumebuilder.h .

A VolumeBuilder object is an instance of Ovolumebuilder .

VolumeBuilder

Creation

A VolumeBuilder object is created with these functions:

VolumeBuilder::Alloc() : Creates a new VolumeBuilder 对象。
VolumeBuilder::Free() : Deletes the given VolumeBuilder 对象。

// This example creates a new VolumeBuilder object and // adds it to the given BaseDocument.

VolumeBuilder * const volumeBuilder = VolumeBuilder::Alloc (); if (volumeBuilder == nullptr ) return maxon::OutOfMemoryError( MAXON_SOURCE_LOCATION );

doc-> InsertObject (volumeBuilder, nullptr , nullptr );

Input Objects

A VolumeBuilder creates volumes based on various input objects. Such input objects are added or removed to the input objects list with these functions:

VolumeBuilder::AddSceneObject() : Adds the given BaseObject to the list.
VolumeBuilder::RemoveObject() : Removes the object at the given index.
VolumeBuilder::ClearInputObjects() : Clears the list of input objects.

// This example adds the given scene object as a source object for the volume builder. const Int32 index = 0;

// add the given object if (volumeBuilder-> AddSceneObject ( object , index, true , BOOLTYPE::UNION , MIXTYPE::NORMAL ) == false ) return maxon::UnexpectedError( MAXON_SOURCE_LOCATION );

// get the corresponding settings BaseContainer * const settings = volumeBuilder-> GetSettingsContainerForIndex (index); if (settings == nullptr ) return maxon::UnexpectedError( MAXON_SOURCE_LOCATION );

// set settings settings-> SetBool ( ID_VOLUMEBUILDER_TAG_OPTIMIZEANDCLOSE , true );

The objects in the input list are accessed with:

VolumeBuilder::GetListEntryCount() : Returns the number of all input elements (objects and folders).
VolumeBuilder::GetInputObjectCount() : Returns the number of input objects.
VolumeBuilder::GetInputObject() ：返回 BaseObject at the given index.
VolumeBuilder::GetInputObjectByType() ：返回 BaseObject of the given type.
VolumeBuilder::InputObjectIsChild() : Returns true if the object at the given index is a child of the VolumeBuilder 对象。

// This example loops through all input elements of the given // VolumeBuilder object. const Int32 inputCount = volumeBuilder-> GetListEntryCount (); for ( Int32 i = 0; i < inputCount; ++i) { const BaseObject * const inputObject = volumeBuilder-> GetInputObject (i); if (inputObject != nullptr ) { // get input name const maxon::String name = inputObject-> GetName (); DiagnosticOutput ( "Object: @" , name);

// check if child object if (volumeBuilder-> InputObjectIsChild (i)) DiagnosticOutput ( "(Child object)" ); } }

For each input object various settings can be set (see tvolumebuilder.h ). The BaseContainer storing these settings is accessed with:

VolumeBuilder::GetSettingsContainerForIndex() ：返回 BaseContainer for the object at the given index.
VolumeBuilder::GetSettingsContainerForObject() ：返回 BaseContainer for the given BaseObject .

// This example gets the settings BaseContainer or the given input object. BaseContainer * const settings = volumeBuilder-> GetSettingsContainerForObject (inputObject); if (settings == nullptr ) return maxon::UnexpectedError( MAXON_SOURCE_LOCATION ); settings-> SetBool ( ID_VOLUMEBUILDER_TAG_USEPOINTS , true ); settings-> SetFloat ( ID_VOLUMEBUILDER_TAG_MESHRADIUS , 10.0);

The bool mode ( BOOLTYPE ) of a given object is accessed with:

VolumeBuilder::GetBoolMode() : Returns the bool mode for the given index.
VolumeBuilder::SetBoolMode() : Sets the bool mode for the given index.

The mix mode (::MIXTYPE) of a given object is accessed with:

VolumeBuilder::GetMixMode() : Returns the mix mode for the given index.
VolumeBuilder::SetMixMode() : Sets the mix mode for the given index.

The functional state of an object in the list is accessed by:

VolumeBuilder::GetEnable() : Returns the enabled state for the given index.
VolumeBuilder::SetEnable() : Sets the enabled state for the given index.

The selection state of an object in the list is accessed with:

VolumeBuilder::GetSelected() : Returns the selection state for the given index.
VolumeBuilder::SetSelected() : Sets the selection state for the given index.

The MIXVECTORTYPE defines how vector data is handled:

VolumeBuilder::GetMixVectorMode() : Returns the mix vector mode for the given index.
VolumeBuilder::SetMixVectorMode() : Sets the mix vector mode for the given index.

// This example enables all selected input objects and disables un-selected objects. const Int32 objectCount = volumeBuilder-> GetListEntryCount (); for ( Int32 i = 0; i < objectCount; ++i) { const Bool selected = volumeBuilder-> GetSelected (i); if (selected) volumeBuilder-> SetEnable (i, true ); else volumeBuilder-> SetEnable (i, false ); }