SpringDefinitions Class

Summary

[System.SerializableAttribute] Defines the core details for a spring simulation.
Assembly
FlexiMotion.dll
Namespace
FlexiMotion
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["ICopyable<SpringDefinitions>"] Type-.->Interface1["IValidatable"] click Interface1 "/flexi-motion/api/FlexiMotion/IValidatable" Type-.->Interface2["ISerializationCallbackReceiver"] Type["SpringDefinitions"] class Type type-node

Syntax

[Serializable]
public class SpringDefinitions : ICopyable<SpringDefinitions>, IValidatable, 
    ISerializationCallbackReceiver

Attributes

Type Description
SerializableAttribute

Fields

Name Constant Value Summary
DetailsField _Details
The name of the serialized backing field of FlexiMotion.SpringDefinitions.Details.
static
RadiiField _Radii
The name of the serialized backing field of FlexiMotion.SpringDefinitions.Radii.
static
TransformsField _Transforms
The name of the serialized backing field of FlexiMotion.SpringDefinitions.Transforms.
static

Properties

Name Value Summary
Count int
The number of springs.
Details SpringDetails[]
The FlexiMotion.SpringDetails of each spring.
Radii float[]
The collision radius of each spring's tail.
Transforms Transform[]
The UnityEngine.Transform of each spring.

Methods

Name Value Summary
Add(Transform, SpringDetails, float) void
Adds a spring at the end of the arrays.
Contains(Transform) bool
Does the FlexiMotion.SpringDefinitions.Transforms array contain the `transform`?
CopyFrom(SpringDefinitions) 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(SpringDefinitions) 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.
IndexOf(Transform) int
Returns the index of the `transform` in the FlexiMotion.SpringDefinitions.Transforms array.
Remove(int) void
Removes the spring at the specified `index`.
RemoveMissingAndDuplicate() bool
Removes any springs with missing or identical FlexiMotion.SpringDefinitions.Transforms.
Validate() bool
Ensures that this object's fields have valid values and returns true if anything was changed.
ValidateArraySizes() bool
Ensures that all the arrays have the same size.

Operators

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

Extension Methods

Name Value Summary
LogTemp<SpringDefinitions>(Object) T
Debug.Log(message, context) with an [System.ObsoleteAttribute] warning so you remember to remove any calls.
SafeGetHashCode<SpringDefinitions>() int
Uses System.Collections.Generic.EqualityComparer`1.Default to get a hash code.