c4d.modules.volume.VolumeObject

class c4d.modules.volume.VolumeObject

The volume object class of type Ovolume.

New in version R20.

Methods Signatures

VolumeObject.__init__(self)

Creates a VolumeObject.

VolumeObject.GetGridType(self)	Returns the grid type.
VolumeObject.GetGridClass(self)	Returns the grid class.
VolumeObject.GetVolume(self)	Returns the core volume object.
VolumeObject.SetVolume(self, volume)	Sets the core volume object.

Inheritance

Inheritance

Parent Class:

• c4d.BaseObject

Methods Documentation

VolumeObject.__init__(self)

Creates a VolumeObject.

Return type:c4d.modules.volume.VolumeObject Returns:A VolumeObject.

VolumeObject.GetGridType(self)

Returns the grid type.

Return type:int Returns:The grid type:

GRIDTYPE_NONE	None.
GRIDTYPE_FLOAT	32-bit float.
GRIDTYPE_DOUBLE	64-bit float.
GRIDTYPE_INT32	32-bit integer.
GRIDTYPE_INT64	64-bit integer.
GRIDTYPE_INTVECTOR32	32-bit integer vector.
GRIDTYPE_VECTOR32	32-bit vector.
GRIDTYPE_VECTOR64	64-bit vector.
GRIDTYPE_STRING	String.
GRIDTYPE_BOOLEAN	Bool.

VolumeObject.GetGridClass(self)

Returns the grid class.

Return type:int Returns:The grid class:

GRIDCLASS_NONE	None.
GRIDCLASS_SDF	SDF.
GRIDCLASS_FOG	Fog.
GRIDCLASS_STAGGERED	Staggered.
GRIDCLASS_UNKNOWN	Unknow.

VolumeObject.GetVolume(self)

Returns the core volume object.

Return type:maxon.frameworks.volume.VolumeRef Returns:The core volume object.

VolumeObject.SetVolume(self, volume)

Sets the core volume object.

Parameters:volume (maxon.frameworks.volume.VolumeRef) – The core volume object to set.