VolumeHelper : Helper

VolumeHelper - superclass: helper; super-superclass:node - 5:0 - classID: #(1050628463L, 453181870L); creatable: true

The VolumeHelper is a helper object in a scene used by a MaxLiquid to define a volume. Available in 3ds Max 2019.1 and higher.

Constructor

VolumeHelper...

Properties

<VolumeHelper>.color     Color    default: (color 0 255 0)   --  RGB color

Gets or sets the VolumeHelper object color.

<VolumeHelper>.meshNode     UndefinedClass    default: undefined   --  node

Gets or sets the scene node to use as the volume shape, when volumeType is 4 (Mesh).

<VolumeHelper>.sectionRadius     Float    default: 0.5   --  animatable; float

Gets or sets the VolumeHelper inner radius, when the volumeType is 3 (Torus).

<VolumeHelper>.size     Float    default: 10.0   --  animatable; float

Gets or sets the VolumeHelper size, in scene units.

<VolumeHelper>.volumeType     Integer    default: 0   --  integer

Gets or sets the VolumeHelper shape type, where:

0 = Box
1 = Sphere
2 = Cylinder
3 = Torus
4 = Mesh

Interfaces

Interface: VolumeHelper

Properties

Methods

    <boolean>IsVolumeOK <time>time

If the VolumeHelper.volumeType is #mesh, this method returns false if no mesh node has been assigned, true if it has.

    <void>SetGizmoType <enum>type
       type enums: {#box|#sphere|#cylinder|#torus|#mesh}
    <enum>GetGizmoType()
       GetGizmoType enums: {#box|#sphere|#cylinder|#torus|#mesh

Gets or sets the VolumeHelper shape type.

    <void>SetGizmoSize <time>time <float>value
    <float>GetGizmoSize <time>time <&interval>interval
       interval is In and Out parameter

Gets or sets the VolumeHelper shape size.

    <void>SetSectionRadius <time>time <float>value
    <float>GetSectionRadius <time>time <&interval>interval
       interval is In and Out parameter

Gets or sets the VolumeHelper section radius at the specified time, when the volume type is a torus.

    <boolean>GetGizmoMesh <&mesh>meshOut <time>time <&interval>interval
       meshOut is Out parameter
       interval is In and Out parameter

Gets the VolumeHelper mesh at the specified time.

Actions