Class ClothSettings

Settings used for customizing the behaviour of cloth simulation.

Constructors

constructor

new ClothSettings(linearInertia?, angularInertia?, centrifugalInertia?, linearDrag?, angularDrag?, dragCoefficient?, liftCoefficient?, windVelocity?, gravity?, solverFrequency?, damping?, tetherConstraintScale?, tetherConstraintStiffness?, friction?, fluidDensity?, isContinousCollisionDetectionEnabled?): ClothSettings
Parameters
- OptionallinearInertia: Immutable<Vector3>
- OptionalangularInertia: Immutable<Vector3>
- OptionalcentrifugalInertia: Immutable<Vector3>
- OptionallinearDrag: Immutable<Vector3>
- OptionalangularDrag: Immutable<Vector3>
- OptionaldragCoefficient: number
- OptionalliftCoefficient: number
- OptionalwindVelocity: Immutable<Vector3>
- Optionalgravity: Immutable<Vector3>
- OptionalsolverFrequency: number
- Optionaldamping: Immutable<Vector3>
- OptionaltetherConstraintScale: number
- OptionaltetherConstraintStiffness: number
- Optionalfriction: number
- OptionalfluidDensity: number
- OptionalisContinousCollisionDetectionEnabled: boolean
Returns ClothSettings

Properties

`Protected`_angularDrag

_angularDrag: Vector3

`Protected`_angularInertia

_angularInertia: Vector3

`Protected`_centrifugalInertia

_centrifugalInertia: Vector3

`Protected`_damping

_damping: Vector3

`Protected`_dragCoefficient

_dragCoefficient: number

`Protected`_fluidDensity

_fluidDensity: number

`Protected`_friction

_friction: number

`Protected`_gravity

_gravity: Vector3

`Protected`_isContinousCollisionDetectionEnabled

_isContinousCollisionDetectionEnabled: boolean

`Protected`_liftCoefficient

_liftCoefficient: number

`Protected`_linearDrag

_linearDrag: Vector3

`Protected`_linearInertia

_linearInertia: Vector3

`Protected`_solverFrequency

_solverFrequency: number

`Protected`_tetherConstraintScale

_tetherConstraintScale: number

`Protected`_tetherConstraintStiffness

_tetherConstraintStiffness: number

`Protected`_windVelocity

_windVelocity: Vector3

Accessors

angularDrag

get angularDrag(): Vector3
Returns Vector3
set angularDrag(value): void
Parameters
- value: Immutable<Vector3>
Returns void

angularInertia

get angularInertia(): Vector3
Returns Vector3
set angularInertia(value): void
Parameters
- value: Immutable<Vector3>
Returns void

centrifugalInertia

get centrifugalInertia(): Vector3
Returns Vector3
set centrifugalInertia(value): void
Parameters
- value: Immutable<Vector3>
Returns void

damping

get damping(): Vector3
Returns Vector3
set damping(value): void
Parameters
- value: Immutable<Vector3>
Returns void

dragCoefficient

get dragCoefficient(): number
Returns number
set dragCoefficient(value): void
Parameters
- value: number
Returns void

fluidDensity

get fluidDensity(): number
Returns number
set fluidDensity(value): void
Parameters
- value: number
Returns void

friction

get friction(): number
Returns number
set friction(value): void
Parameters
- value: number
Returns void

gravity

get gravity(): Vector3
Returns Vector3
set gravity(value): void
Parameters
- value: Immutable<Vector3>
Returns void

isContinousCollisionDetectionEnabled

get isContinousCollisionDetectionEnabled(): boolean
Returns boolean
set isContinousCollisionDetectionEnabled(value): void
Parameters
- value: boolean
Returns void

liftCoefficient

get liftCoefficient(): number
Returns number
set liftCoefficient(value): void
Parameters
- value: number
Returns void

linearDrag

get linearDrag(): Vector3
Returns Vector3
set linearDrag(value): void
Parameters
- value: Immutable<Vector3>
Returns void

linearInertia

get linearInertia(): Vector3
Returns Vector3
set linearInertia(value): void
Parameters
- value: Immutable<Vector3>
Returns void

solverFrequency

get solverFrequency(): number
Returns number
set solverFrequency(value): void
Parameters
- value: number
Returns void

tetherConstraintScale

get tetherConstraintScale(): number
Returns number
set tetherConstraintScale(value): void
Parameters
- value: number
Returns void

tetherConstraintStiffness

get tetherConstraintStiffness(): number
Returns number
set tetherConstraintStiffness(value): void
Parameters
- value: number
Returns void

windVelocity

get windVelocity(): Vector3
Returns Vector3
set windVelocity(value): void
Parameters
- value: Immutable<Vector3>
Returns void

Methods

assign

assign(other): ClothSettings
Copies all properties defined by the prototype of ClothSettings from other to this instance.
Parameters
- other: Immutable<ClothSettings>
Returns ClothSettings

clone

clone(): ClothSettings
Clones this instance and returns a new ClothSettings with identical values.

Returns ClothSettings

isEqual

isEqual(this, other): boolean
Determines if this ClothSettings instance is equal to the other instance.
Parameters
- this: Immutable<ClothSettings>
- other: Immutable<ClothSettings>
Returns boolean

`Static`isEqual

isEqual(lhs, rhs): boolean
Determines if both ClothSettings instances are equal.
Parameters
- lhs: Immutable<ClothSettings>
- rhs: Immutable<ClothSettings>
Returns boolean