MEMBERS

values :Array

IncisorAPI.js, line 4570

Array of keyframes representing the ramp. Each keyframe is specified as an array with two elements. The first element must be a number representing the time of the keyframe. Ramp evaluations are performed in the range 0-1, but keyframes may specify times outside this range. The second element must be a Vector2. [DEFAULT: []]

Members below are inherited from the parent class.

inputMaximum :number

IncisorAPI.js, line 4497

When using inputType equal to 'EmissionTime', the emission time is divided by this number and the fractional component of the result is used to look up a value in the ramp. This means that particles emitted after this time will use values that wrap around to the beginning of the ramp. When using a non-infinite emissionDuration, it is common to set this value to emissionDuration + emissionTimeRandomness so that the ramp applies over the duration of the particle emission.

Inherited From:

• ParticleSystemRamp.inputMaximum()

inputType :string

IncisorAPI.js, line 4489

The input type used when evaluating. See nc.particleSystemRampInputTypes for valid values.

Inherited From:

• ParticleSystemRamp.inputType()

interpolationType :string

IncisorAPI.js, line 4504

The type of interpolation to apply between the keyframes. See nc.constants.particleSystemRampInterpolationTypes for valid values.

Inherited From:

• ParticleSystemRamp.interpolationType()

type :string

IncisorAPI.js, line 4510

Type identifier.

Inherited From:

• ParticleSystemRamp.type()

METHODS

addKeyframe(x, y)

IncisorAPI.js, line 4579

Adds a new keyframe. If a keyframe already exists at this time value, it is overwritten.

Parameters:

Name	Type	Attributes	Default	Description
x	number			The time value for this keyframe.
y	Vector2			The value stored at this keyframe.

isEqual(particleSystemRamp2) returns {boolean}

IncisorAPI.js, line 4587

Tests whether another ParticleSystemRamp2 has identical contents to this ParticleSystemRamp2.

Parameters:

Name	Type	Attributes	Default	Description
particleSystemRamp2	ParticleSystemRamp2			The ParticleSystemRamp2 to compare to.

Returns:

boolean

Methods below are inherited from the parent class.

refreshKeyframeOrder()

IncisorAPI.js, line 4517

Refreshes the order of the keyframes, ensuring they are stored in order of increasing time.

Inherited From:

• ParticleSystemRamp.refreshKeyframeOrder()

removeKeyframe(x)

IncisorAPI.js, line 4524

Removes the keyframe with the given time value.

Parameters:

Name	Type	Attributes	Default	Description
x	number			The time value of the keyframe to remove. If no such keyframe exists, nothing is removed.

Inherited From:

• ParticleSystemRamp.removeKeyframe()