WeightedMaskLayersDefinition Class

Summary

Serializable data which defines how to control a Animancer.WeightedMaskLayerList.
Assembly
Animancer.dll
Namespace
Animancer
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["ICopyable<WeightedMaskLayersDefinition>"] Type-.->Interface1["IEquatable<WeightedMaskLayersDefinition>"] Type-.->Interface2["ISerializationCallbackReceiver"] Type["WeightedMaskLayersDefinition"] class Type type-node

Syntax

[Serializable]
public class WeightedMaskLayersDefinition : ICopyable<WeightedMaskLayersDefinition>, 
    IEquatable<WeightedMaskLayersDefinition>, ISerializationCallbackReceiver

Attributes

Type Description
SerializableAttribute

Fields

Name Constant Value Summary
TransformsField _Transforms
The name of the serialized backing field of Animancer.WeightedMaskLayersDefinition.Transforms.
static
WeightsField _Weights
The name of the serialized backing field of Animancer.WeightedMaskLayersDefinition.Weights.
static

Properties

Name Value Summary
GroupCount int
The number of weight groups in this definition.
IsValid bool
Does this definition contain valid data?
Transforms Transform[]
UnityEngine.Transforms being controlled by this definition.
Weights float[]
Groups of weights which will be applied to the Animancer.WeightedMaskLayersDefinition.Transforms.

Methods

Name Value Summary
AddTransform(Transform) void
Adds the `transform` at the specified `index` along with any associated Animancer.WeightedMaskLayersDefinition._Weights.
AssertGroupIndex(int) void
[Assert-Conditional] Asserts that the `groupIndex` is valid.
CalculateIndices(WeightedMaskLayerList) int[]
Calculates the index of each of the Animancer.WeightedMaskLayersDefinition.Transforms.
CopyFrom(WeightedMaskLayersDefinition, CloneContext) void
Copies the contents of `copyFrom` into this object, replacing its previous contents.
Equals(Object) bool
Are all fields in this object equal to the equivalent in `obj`?
Equals(WeightedMaskLayersDefinition) bool
Are all fields in this object equal to the equivalent fields in `other`?
GetHashCode() int
Returns a hash code based on the values of this object's fields.
GetWeight(int, int) float
Gets the specified weight.
IndexOf(int, int) int
Calculates the index in the Animancer.WeightedMaskLayersDefinition.Weights corresponding to the specified values.
IndexOfGroup(int) int
Calculates the index in the Animancer.WeightedMaskLayersDefinition.Weights corresponding to the specified values.
OnValidate() bool
RemoveMissingAndDuplicate() bool
Removes any missing or identical Animancer.WeightedMaskLayersDefinition._Transforms.
RemoveTransform(int) void
Removes the `index` from the Animancer.WeightedMaskLayersDefinition._Transforms along with any associated Animancer.WeightedMaskLayersDefinition._Weights.
SetWeight(int, int, float) bool
Sets the specified weight.
ToString() string
Returns a summary of this definition.
ValidateArraySizes() bool
Ensures that all the arrays have valid sizes.

Operators

Name Value Summary
operator !=(WeightedMaskLayersDefinition, WeightedMaskLayersDefinition) bool
operator ==(WeightedMaskLayersDefinition, WeightedMaskLayersDefinition) bool