Parameter

Parameters are configurable values that are used to drive mesh deformations, property overrides, and more.

abstract

class Parameter : NuRefCounted, ISerializable , IDeserializable!ModelState {

void onSerialize(DataNode object);

void onDeserialize(DataNode object, ModelState state);

void onFinalize(Puppet puppet, ModelState state);

nstring name;

vector!ParameterBinding bindings;

int dimensions [@property getter];

uint[] elementCounts [@property getter];

float[] currentValue [@property getter];

float[] lowerBound [@property getter];

float[] upperBound [@property getter];

bool hasBinding(Node node, string prop);

bool hasAnyBindingsTo(Node node);

void serialize(DataNode object);

void deserialize(DataNode object, ModelState state);

void finalize(Puppet puppet, ModelState state);

void update();

}

Members

Functions

deserialize void deserialize(DataNode object, ModelState state): Deserializes this parameter.
finalize void finalize(Puppet puppet, ModelState state): Finalizes the parameter.
hasAnyBindingsTo bool hasAnyBindingsTo(Node node): Check whether this parameter has any bindings to the given node.
hasBinding bool hasBinding(Node node, string prop): Check whether this parameter has a binding to the given target.
onDeserialize void onDeserialize(DataNode object, ModelState state): Deserialize this parameter.
onFinalize void onFinalize(Puppet puppet, ModelState state): Finalizes the parameter.
onSerialize void onSerialize(DataNode object): Serialize this parameter.
serialize void serialize(DataNode object): Serializes this parameter.
update void update(): Update our bindings with the value of this parameter.

Properties

currentValue float[] currentValue [@property getter]: The current value of the parameter.
dimensions int dimensions [@property getter]: The dimensionality of the parameter.
elementCounts uint[] elementCounts [@property getter]: Counts of elements in each axis.
lowerBound float[] lowerBound [@property getter]: The lower bound of this parameter.
upperBound float[] upperBound [@property getter]: The upper bound of this parameter.

Variables

active bool active;: Whether this parameter currently updates the model.
bindings vector!ParameterBinding bindings;: The bindings of this parameter to puppet nodes.
guid GUID guid;: The globally unique ID of this parameter.
name nstring name;: The user-facing name of this parameter.

Inherited Members

From ISerializable

onSerialize void onSerialize(DataNode object): Custom serializer function

Meta

Source

See Implementation

inochi2d param parameters modules

classes

Parameter

enums

functions

static variables

in_param_registry