Class Flexalon
- Namespace
- Flexalon
- Assembly
- Flexalon.dll
Singleton class which tracks and updates all FlexalonNodes in the scene. See core concepts for more information.
public class Flexalon : MonoBehaviour
- Inheritance
-
objectFlexalon
Fields
PreUpdate
Event invoked before Flexalon updates.
public System.Action PreUpdate
Field Value
- Action
Properties
InputProvider
Override the default InputProvider used by FlexalonInteractables to support other input devices.
public InputProvider InputProvider { get; set; }
Property Value
Nodes
Set of nodes representing GameObjects tracked by Flexalon.
public IReadOnlyCollection<FlexalonNode> Nodes { get; }
Property Value
- IReadOnlyCollection<FlexalonNode>
RecordFrameChanges
public static bool RecordFrameChanges { get; set; }
Property Value
- bool
SkipInactiveObjects
Determines if Flexalon should automatically skip inactive gameObjects in a layout.
public bool SkipInactiveObjects { get; set; }
Property Value
- bool
UpdateInEditMode
Determines if Flexalon should automatically update in edit mode.
public bool UpdateInEditMode { get; set; }
Property Value
- bool
UpdateInPlayMode
Determines if Flexalon should automatically update in play mode.
public bool UpdateInPlayMode { get; set; }
Property Value
- bool
Methods
AddComponent(GameObject, Type)
Helper to ensure undo operation on AddComponent is handled correctly.
public static Component AddComponent(GameObject go, System.Type type)
Parameters
goGameObjecttypeType
Returns
- Component
AddComponent<T>(GameObject)
Helper to ensure undo operation on AddComponent is handled correctly.
public static T AddComponent<T>(GameObject go) where T : Component
Parameters
goGameObject
Returns
- T
Type Parameters
T
ForceUpdate()
Marks every node and FlexalonComponent as dirty and calls UpdateDirtyNodes.
public void ForceUpdate()
Get()
Returns the singleton Flexalon component.
public static Flexalon Get()
Returns
- Flexalon
The singleton Flexalon component, or null if it doesn't exist.
GetInputProvider()
Gets the current InputProvider used by FlexalonInteractables.
public static InputProvider GetInputProvider()
Returns
GetNode(GameObject)
Returns the FlexalonNode associated with the gameObject.
public static FlexalonNode GetNode(GameObject go)
Parameters
goGameObjectThe gameObject to get the FlexalonNode for.
Returns
- FlexalonNode
The FlexalonNode associated with the gameObject, or null if it doesn't exist.
GetOrCreate()
public static Flexalon GetOrCreate()
Returns
GetOrCreateNode(GameObject)
Returns the FlexalonNode associated with the gameObject, or creates it if it doesn't exist.
public static FlexalonNode GetOrCreateNode(GameObject go)
Parameters
goGameObjectThe gameObject to get the FlexalonNode for.
Returns
- FlexalonNode
The FlexalonNode associated with the gameObject.
UpdateDirtyNodes()
Updates all dirty nodes.
public void UpdateDirtyNodes()