SphereCollidersModifier Class

Summary

A FlexiMotion.Modifiers.FlexiMotionModifier which applies collisions against sphere colliders.
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["JobModifierGroup.IOnInitialize"] click Interface1 "/flexi-motion/api/FlexiMotion.Modifiers/IOnInitialize" Type-.->Interface2["JobModifierGroup.IPreUpdate"] click Interface2 "/flexi-motion/api/FlexiMotion.Modifiers/IPreUpdate" Type-.->Interface3["JobModifierGroup.IOnUpdate"] click Interface3 "/flexi-motion/api/FlexiMotion.Modifiers/IOnUpdate" Type-.->Interface4["ISphereCollidersModifier"] click Interface4 "/flexi-motion/api/FlexiMotion.Modifiers/ISphereCollidersModifier" Type-.->Interface5["IComponent"] click Interface5 "/flexi-motion/api/FlexiMotion/IComponent" Type-.->Interface6["IOnValidate"] click Interface6 "/flexi-motion/api/FlexiMotion/IOnValidate" Type["SphereCollidersModifier"] class Type type-node

Syntax

[AddComponentMenu(FMStrings.ModifiersMenuPrefix + "Sphere Colliders Modifier")]
[HelpURL(FMStrings.DocsURLs.ModifiersAPIDocumentation + "/" + nameof(SphereCollidersModifier))]
public class SphereCollidersModifier : FlexiMotionModifier, IFlexiMotionModifier, 
    JobModifierGroup.IOnInitialize, JobModifierGroup.IPreUpdate, JobModifierGroup.IOnUpdate, 
    ISphereCollidersModifier, IComponent, IOnValidate

Attributes

Type Description
AddComponentMenu
HelpURLAttribute

Fields

Name Constant Value Summary
CollidersFieldName _Colliders
The name of the serialized backing field of FlexiMotion.Modifiers.SphereCollidersModifier.Colliders.
static
ExecutionTime 1000
Execute fairly early.
static
TargetFieldName _Target
The name of the serialized backing field of FlexiMotion.Modifiers.FlexiMotionModifier.Target.
Inherited from FlexiMotionModifier
static

Properties

Name Value Summary
Colliders SphereColliderDefinitions
[UnityEngine.SerializeField] Data from which the FlexiMotion.Modifiers.SphereCollidersModifier.Runtime will be initialized.
DeltaTime float
The FlexiMotion.FlexiMotionRuntime.DeltaTime.
Inherited from FlexiMotionModifier
Runtime RuntimeSphereColliders
The collider job manager.
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.
OnDestroy() void
Disposes everything allocated by this system.
OnDisable() void
Calls FlexiMotion.Modifiers.FlexiMotionModifier.Disable(FlexiMotion.Modifiers.JobModifierGroup) if the FlexiMotion.Modifiers.FlexiMotionModifier.Target is set.
Inherited from FlexiMotionModifier
OnDrawGizmosSelected() void
Draws scene gizmos for this modifier.
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.
OnUpdate(JobHandle) JobHandle
A job modifier which runs after each iteration of an update.
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<SphereCollidersModifier>(Object) T
Debug.Log(message, context) with an [System.ObsoleteAttribute] warning so you remember to remove any calls.
SafeGetHashCode<SphereCollidersModifier>() int
Uses System.Collections.Generic.EqualityComparer`1.Default to get a hash code.