TwistModifier Class

Module: Animation

The twist modifier applies a tornado twist like deformation to the geometry.

It follows a vector from a start to and end point in the vector and rotates all vertex for each point up to a defined final angle.

Item Index

Methods

Attributes

Methods

modify

(
  • geometry
)
Geometry | BufferGeometry

Apply the modifier to a geometry object, creates a new geometry with the result.

Parameters:

  • geometry Geometry | BufferGeometry

    Geometry to be transformed.

Returns:

Geometry | BufferGeometry:

Result geometry after applying the modifier.

Attributes

angle

Number

Twist angle of rotation, applied from the start to the end of rotation.

bufferGeometry

Boolean

Indicates if the output should be a buffer geometry or a regular geometry.

direction

Vector3

Twist direction vector, the twist is performed around this vector in its direction.

start

Number

Start height of the twist rotation.

This values is in geometry coordinate space.