ScaleModifier Class

Summary

A FlexiMotion.Modifiers.FlexiMotionModifier which accounts for scaled objects.
Assembly
FlexiMotion.dll
Namespace
FlexiMotion.Modifiers
Interfaces
Base Types
graph BT Type-->Base0["FlexiMotionModifier"] click Base0 "/flexi-motion/api/FlexiMotion.Modifiers/FlexiMotionModifier" Base0-->Base1["MonoBehaviour"] Type-.->Interface0["IFlexiMotionModifier"] click Interface0 "/flexi-motion/api/FlexiMotion.Modifiers/IFlexiMotionModifier" Type-.->Interface1["IOnValidate"] click Interface1 "/flexi-motion/api/FlexiMotion/IOnValidate" Type-.->Interface2["JobModifierGroup.IOnInitialize"] click Interface2 "/flexi-motion/api/FlexiMotion.Modifiers/IOnInitialize" Type-.->Interface3["JobModifierGroup.IPreUpdate"] click Interface3 "/flexi-motion/api/FlexiMotion.Modifiers/IPreUpdate" Type["ScaleModifier"] class Type type-node

Syntax

[AddComponentMenu(FMStrings.ModifiersMenuPrefix + "Scale Modifier")]
[HelpURL(FMStrings.DocsURLs.ModifiersAPIDocumentation + "/" + nameof(ScaleModifier))]
[DefaultExecutionOrder(1000)]
public class ScaleModifier : FlexiMotionModifier, IFlexiMotionModifier, IOnValidate, 
    JobModifierGroup.IOnInitialize, JobModifierGroup.IPreUpdate

Attributes

Type Description
AddComponentMenu
HelpURLAttribute
DefaultExecutionOrder

Fields

Name Constant Value Summary
ExecutionTime -2000
Execute before other things that might need the scaled values.
static
TargetFieldName _Target
The name of the serialized backing field of FlexiMotion.Modifiers.FlexiMotionModifier.Target.
Inherited from FlexiMotionModifier
static

Properties

Name Value Summary
DeltaTime float
The FlexiMotion.FlexiMotionRuntime.DeltaTime.
Inherited from FlexiMotionModifier
IsDynamic bool
Does the scale change after initialization?
SphereColliders SphereCollidersModifier
Colliders that will have their values scaled.
Target FlexiMotionComponent
Inherited from FlexiMotionModifier

Methods

Name Value Summary
Disable(JobModifierGroup) bool
Registers this modifier in the given FlexiMotion.Modifiers.JobModifierGroup.
Enable(JobModifierGroup) void
Registers this modifier in the given FlexiMotion.Modifiers.JobModifierGroup.
GetUsedBones() IEnumerable<Transform>
Returns the objects that are used by this modifier.
Inherited from FlexiMotionModifier
OnDestroy() void
Disposes everything allocated by this modifier.
OnDisable() void
Calls FlexiMotion.Modifiers.FlexiMotionModifier.Disable(FlexiMotion.Modifiers.JobModifierGroup) if the FlexiMotion.Modifiers.FlexiMotionModifier.Target is set.
Inherited from FlexiMotionModifier
OnEnable() void
Calls FlexiMotion.Modifiers.FlexiMotionModifier.Enable(FlexiMotion.Modifiers.JobModifierGroup) if the FlexiMotion.Modifiers.FlexiMotionModifier.Target is set.
Inherited from FlexiMotionModifier
OnInitialize(JobHandle) JobHandle
A job modifier which runs when the simulation is initialized.
OnValidate() void
Tries to find a FlexiMotion.Modifiers.FlexiMotionModifier.Target if none was assigned.
PreUpdate(JobHandle) JobHandle
A job modifier which runs at the start of an update.

Extension Methods

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