c4d.modules.volume

class c4d.modules.volume

Types

• c4d.modules.volume.VolumeBuilder
• c4d.modules.volume.VolumeObject

Functions Signatures

c4d.modules.volume.SendVolumeCommand(command, list, bc, doc)

Sends a volume command.

Functions Documentation

c4d.modules.volume.SendVolumeCommand(command, list, bc, doc)

Sends a volume command.

Parameters

• command (int) –

  The volume command ID:

  VOLUMECOMMANDTYPE_VOLUMETOMESH	Converts a VolumeObject into a PolygonObject.
  VOLUMECOMMANDTYPE_MESHTOVOLUME	Converts a PolygonObject into a SDF VolumeObject.
  VOLUMECOMMANDTYPE_VOLUMEBOOLE	Boolean operation on SDF volume objects.
  VOLUMECOMMANDTYPE_PARTICLESTOVOLUME	Converts particle objects and TP groups to a SDF VolumeObject.
  VOLUMECOMMANDTYPE_SPLINETOVOLUME	Converts a SplineObject to a SDF VolumeObject.
  VOLUMECOMMANDTYPE_FILTER	Filters a float grid VolumeObject.
  VOLUMECOMMANDTYPE_SDFFILTER	Filters a float grid SDF VolumeObject.
  VOLUMECOMMANDTYPE_SDFTOFOG	Converts a SDF Volume to a fog VolumeObject.
  VOLUMECOMMANDTYPE_FOGTOSDF	Converts a fog Volume to a SDF VolumeObject.
  VOLUMECOMMANDTYPE_RESAMPLE	Resamples a VolumeObject to a new grid size.
  VOLUMECOMMANDTYPE_MIX	Mix operation on several fog VolumeObject.
  VOLUMECOMMANDTYPE_FIELDTOVOLUME	Converts a field to a fog VolumeObject.
  VOLUMECOMMANDTYPE_CREATESPHEREVOLUME	Creates a sphere VolumeObject.
  VOLUMECOMMANDTYPE_CREATEPLATONICVOLUME	Creates a platonic VolumeObject.

• list (List[c4d.BaseObject]) – The objects to apply the volume command to.

• bc (c4d.BaseContainer) – The settings container. See VOLUMECOMMANDSETTINGS.

• doc (c4d.documents.BaseDocument) – The document.

Return type

Union[bool, List[c4d.BaseObject]]

Returns

True if the volume command succeeded, otherwise False.

If the volume command succeeds the resulting objects are returned, if any, instead of True.