Windhelper : Helper

Windhelper - superclass: Helper; super-superclass:Node - classID: #(1103585298, 1387146322)

Description:

The Wind Helper allows you to add wind effects to Reactor sumulations.

Constructor:

Windhelper ...

rctWind ...

Properties:

.windSpeed (Wind_Speed) : float

The strength of the wind.

.perturbSpeed (Perturb_Speed) : boolean

When set to true, the strength of the wind will vary over time, using the parameters below:

.speedVariance (Variance) : float

Get/Set the smooth speed value variation over time.

.speedTimeScale (Time_Scale) : float

Get/Set how quickly the speed changes occur. Small values produce a slow change, large values produce a rapid change.

.ripple : boolean

When set to true, the wind direction becomes a function of space and time, allowing you to add rippling effects to cloth objects affected by the wind.

.rippleAxis (Ripple_Axis) : integer

Get/Set the wind axis. Possible values are:

0 - Left/Right

1 - Up/Down

2 - Back/Forward

.rippleMagnitude (Magnitude) : float

Get/Set the directional variance for the ripples

.rippleFrequency (Frequency) : float

Get/Set the regularity of ripple formation

.perturbTime (Perturb_Time) : boolean

When set to true, the spatial perturbation itself is perturbed over time, meaning that the ripples move back and forth.

.rippleTimeMagnitude : float

Get/Set the ripple magnitude used when .perturbTime is enabled.

.rippleTimeFrequency : float

Get/Set the ripple frequency used when .perturbTime is enabled.

.appliesToRigidBodies (Applies_To_Rigid_Bodies) : boolean

When set to true, the Wind will affect Rigid Bodies.

.appliesToCloth (Applies_To_Cloth) : boolean

When set to true, the Wind will affect Cloth.

.appliesToSoftBodies (Applies_To_Soft_Bodies) : boolean

When set to true, the Wind will affect Soft Bodies.

.appliesToRopes (Applies_To_Ropes) : boolean

When set to true, the Wind will affect Ropes.

.enableSheltering (Enable_Sheltering) : boolean

When set to true, sheltering will be enabled - objects sheltered by other objects will not be affected by the Wind.

.disabled : boolean

When set to True, the Windhelper will be disabled.

.useRange (Use_Range) : boolean

When set to true, the wind effect will have the specified range of action, starting from the icon.

.range : float

Get/Set the wind range value.

.falloffType (Falloff_Type) : integer

Get/Set how the wind effect will fall off towards its range limit. Possible values are:

0 - No Falloff

1 - Inverse

2 - Inverse Squared

.isWindOn (Is_Wind_On) : boolean

Enable/Disable the wind effect.

.iconSize (Icon_Size) : float

Get/Set the icon size.

Interfaces:

Interface: rctWindInterface

Properties:

.speed : float : Read|Write

The strength of the wind.

.perturbSpeed : boolean : Read|Write

When set to true, the strength of the wind will vary over time, using the parameters below:

.speedVariance : float : Read|Write

Get/Set the smooth speed value variation over time.

.speedTimeScale : float : Read|Write

Get/Set how quickly the speed changes occur. Small values produce a slow change, large values produce a rapid change.

.ripple : boolean : Read|Write

When set to true, the wind direction becomes a function of space and time, allowing you to add rippling effects to cloth objects affected by the wind.

.rippleDirection : enum : Read|Write

rippleDirection enums: {#upDown|#leftRight|#backForward}

Get/Set the wind axis to the specified enum value.

.rippleMagnitude : float : Read|Write

Get/Set the directional variance for the ripples

.rippleFrequency : float : Read|Write

Get/Set the regularity of ripple formation

.perturbRippleOverTime : boolean : Read|Write

When set to true, the spatial perturbation itself is perturbed over time, meaning that the ripples move back and forth.

.perturbRippleOverTimeMagnitude : float : Read|Write

Get/Set the directional variance for the perturbed ripples

.perturbRippleOverTimeFrequency : float : Read|Write

Get/Set the regularity of the perturbed ripple formation

.appliesToRigidBodies : boolean : Read|Write

When set to true, the Wind will affect Rigid Bodies.

.appliesToCloths : boolean : Read|Write

When set to true, the Wind will affect Cloth.

.appliesToSoftBodies : boolean : Read|Write

When set to true, the Wind will affect Soft Bodies.

.appliesToRopes : boolean : Read|Write

When set to true, the Wind will affect Ropes.

.enableSheltering : boolean : Read|Write

When set to true, sheltering will be enabled - objects sheltered by other objects will not be affected by the Wind.

.useRange : boolean : Read|Write

When set to true, the wind effect will have the specified range of action, starting from the icon.

.range : float : Read|Write

Get/Set the wind range value.

.rangeFalloffType : enum : Read|Write

rangeFalloffType enums: {#noFalloff|#inverse|#inverseSquared}

Get/Set how the wind effect will fall off towards its range limit.

.isWindOn : boolean : Read|Write

Enable/Disable the wind effect.

.isDisabled : boolean : Read|Write

When set to true, the Wind will not be considered by the simulation.

See also

MAXScript Extensions for Reactor