Class: AxParameter

AxParameter(valuenon-null, typenon-null)

new AxParameter(valuenon-null, typenon-null)

Represents a parameter of a specifiv type, which holds a value of that type. Used to store values in axis
Parameters:
Name Type Description
value * The value of the parameter
type AxParameterType Type of the value if the value is a reference
Source:

Methods

(static) GetEffectiveParameter(parameter) → {AxParameter}

Returns the parameter's effective parameter. For parameters which don't reference a mechanism, this would be the parameter itself. For parameters which reference a mechanism, this would be the parameter at the end of the mechanism-reference chain, in other words the parameter wich holds the effective value
Parameters:
Name Type Description
parameter AxParameter The parameter whose effective parameter to get
Source:
Returns:
The effective paramter of the given one
Type
AxParameter

(static) IsReference(type) → {Boolean}

Returns whether a given parameter type is that of a parameter which holds a reference to an object, rather than a value
Parameters:
Name Type Description
type AxParameterType The parameter type to check
Source:
Returns:
True if the given parameter type is that of a reference parameter
Type
Boolean

DisposeValue()

Provided for implementation consistency Disposes of the parameter's value.
Source:

Equals(parameter) → {Boolean}

Returns whether the value of the parameter is equal to the value of another parameter
Parameters:
Name Type Description
parameter AxParameter The parameter to compare value against
Source:
Returns:
True if the value of the parameter is equal to the value of the provided parameter
Type
Boolean

GetBool() → {Boolean}

Provided for implementation consistency. Use GetEffectiveValue instead Gets the effective value of the parameter as a boolean
Source:
Returns:
The parameter's effective value as a boolean
Type
Boolean

GetColor() → {AxVector4}

Provided for implementation consistency. Use GetEffectiveValue instead Gets the effective value of the parameter as a color vector
Source:
Returns:
The parameter's effective value as a boolean
Type
AxVector4

GetEffectiveParameter() → {AxParameter}

Gets the parameter's effective parameter For parameters referencing a mechanism chain, this would be the parameter of the mechanism at the end of the chain. Otherwise it's the parameter
Source:
Returns:
The parameter's effective parameter.
Type
AxParameter

GetEffectiveValue() → {*}

Gets the parameter's effective value of the parameter For parameters referencing a mechanism chain, this would be the value of the mechanism's parameter at the end of the chain. Otherwise it's the parameter's value itself
Source:
Returns:
The effective value of the parameter
Type
*

GetFloat() → {Number}

Provided for implementation consistency. Use GetEffectiveValue instead Gets the effective value of the parameter as a floating point
Source:
Returns:
The parameter's effective value as a floating point
Type
Number

GetInt() → {Integer}

Provided for implementation consistency. Use GetEffectiveValue instead Gets the effective value of the parameter as an integer
Source:
Returns:
The parameter's effective value as an integer
Type
Integer

IsReference() → {Boolean}

Returns whether the parameter holds a reference value
Source:
Returns:
True if the value of the parameter is a reference
Type
Boolean

RecallEffectiveParameter()

Sets the parameter value to it's evvective value This eliminates any reference chain and makes the parameter adopt the value at the end of that chain at the moment of the recall. For non reference chain parameter, the value remains the same
Source:

SetBool(value)

Provided for implementation consistency. Use SetValue instead
Parameters:
Name Type Description
value Boolean The boolean value to be set Sets a boolean value to the parameter
Source:

SetColor(value)

Provided for implementation consistency. Use SetValue instead
Parameters:
Name Type Description
value AxVector4 The color vector value to be set Sets a color vector value to the parameter
Source:

SetFloat(value)

Provided for implementation consistency. Use SetValue instead
Parameters:
Name Type Description
value Number The floating point value to be set Sets a floating point value to the parameter
Source:

SetInt(value)

Provided for implementation consistency. Use SetValue instead
Parameters:
Name Type Description
value Integer The integer value to be set Sets an integer value to the parameter
Source:

SetType(type)

Sets the parameter's type, initializing it's value, if necessary
Parameters:
Name Type Description
type AxParameterType Type to set for the parameter
Source:

SetValue(value, type)

Sets the parameter's value to a referece
Parameters:
Name Type Description
value * Value of the referece to set
type AxParameterType Type of the referece to set
Source:

Documentation generated by JSDoc 3.5.3 on Wed Jan 17 2018 17:06:57 GMT+0200 (FLE Standard Time)