CylinderShapeSampler

lumin.particles. CylinderShapeSampler

new CylinderShapeSampler()

Default constructor

Methods

getAngularVelocity() → {vec3}

Inherited From:

Returns the angular velocity of the mesh.

Returns:

velocity

Type
vec3

getHeight() → {number}

Returns the cylinder height.

Returns:

height

Type
number

getInnerRadius() → {number}

Returns the cylinder inner radius.

Returns:

radius

Type
number

getLinearVelocity() → {vec3}

Inherited From:

Returns the linear velocity of the mesh.

Returns:

velocity

Type
vec3

getOuterRadius() → {number}

Returns the cylinder outer radius.

Returns:

radius

Type
number

getType() → {lumin.particles.ShapeSampler.Type}

Inherited From:

Return the shape sampler type.

Returns:

the type

Type
lumin.particles.ShapeSampler.Type

setAngularVelocity(velocity)

Inherited From:

Sets the angular velocity to apply to the mesh.

Parameters:
Name Type Description
velocity vec3

Velocity

setHeight(height)

Sets the cylinder height.

Parameters:
Name Type Description
height number

Height

setInnerRadius(radius)

Sets the cylinder inner radius.

Parameters:
Name Type Description
radius number

Radius

setLinearVelocity(velocity)

Inherited From:

Sets the linear velocity to apply to the mesh.

Parameters:
Name Type Description
velocity vec3

Velocity

setOuterRadius(radius)

Sets the cylinder outer radius.

Parameters:
Name Type Description
radius number

Radius

lumin.particles. CylinderShapeSampler

new CylinderShapeSampler(outerRadius, height, innerRadiusopt)

Constructor

Parameters:
Name Type Attributes Default Description
outerRadius number

Outer radius of the cylinder

height number

Height of the cylinder

innerRadius number <optional>
0

Inner radius of the cylinder

Extends

Methods

getAngularVelocity() → {vec3}

Inherited From:

Returns the angular velocity of the mesh.

Returns:

velocity

Type
vec3

getHeight() → {number}

Returns the cylinder height.

Returns:

height

Type
number

getInnerRadius() → {number}

Returns the cylinder inner radius.

Returns:

radius

Type
number

getLinearVelocity() → {vec3}

Inherited From:

Returns the linear velocity of the mesh.

Returns:

velocity

Type
vec3

getOuterRadius() → {number}

Returns the cylinder outer radius.

Returns:

radius

Type
number

getType() → {lumin.particles.ShapeSampler.Type}

Inherited From:

Return the shape sampler type.

Returns:

the type

Type
lumin.particles.ShapeSampler.Type

setAngularVelocity(velocity)

Inherited From:

Sets the angular velocity to apply to the mesh.

Parameters:
Name Type Description
velocity vec3

Velocity

setHeight(height)

Sets the cylinder height.

Parameters:
Name Type Description
height number

Height

setInnerRadius(radius)

Sets the cylinder inner radius.

Parameters:
Name Type Description
radius number

Radius

setLinearVelocity(velocity)

Inherited From:

Sets the linear velocity to apply to the mesh.

Parameters:
Name Type Description
velocity vec3

Velocity

setOuterRadius(radius)

Sets the cylinder outer radius.

Parameters:
Name Type Description
radius number

Radius