class MAGES::Interaction::MAGESInteractionSystem¶

Overview¶

The MAGES Interaction System module. More…

class MAGESInteractionSystem: public MAGES::InteractionSystemModule
{
public:
    // enums

    enum HandTrackingAimPoseMode;

    // properties

    override List<ILocomotionProvider> ActiveLocomotionProviders;
    Material DefaultHoverMaterial;
    GameObject DefaultReticle;
    HandTrackingAimPoseMode AimPoseMode;
    GameObject DefaultTeleportReticle;
    GameObject OptionsMenu;

    // methods

    override void Startup();
    override void Shutdown();
    virtual override void UpdateModule(UpdatePhase updatePhase);

    virtual override bool TryAddInteractable(
        GameObject gameObject,
        string interactableType,
        out IInteractable component
    );

    virtual override IInteractable GetInteractable(
        GameObject gameObject,
        string interactableType
    );

    virtual override IInteractable GetOrAddInteractable(
        GameObject gameObject,
        string interactableType
    );

    virtual override IInteractable AddGrabbable(GameObject gameObject);
    virtual override IInteractable GetGrabbable(GameObject gameObject);
    virtual override IInteractable GetOrAddGrabbable(GameObject gameObject);

    virtual override bool TryAddInteractor(
        GameObject gameObject,
        string interactorType,
        out IInteractor component
    );

    virtual override IInteractor GetInteractor(
        GameObject gameObject,
        string interactorType
    );

    virtual override IInteractor GetOrAddInteractor(
        GameObject gameObject,
        string interactorType
    );
};

Inherited Members¶

public:
    // enums

    enum InteractorCollisionMode;

    // classes

    class InteractableInfo;
    class InteractorInfo;

    // properties

    int Version;
    GameObject LeftHand;
    GameObject LeftHandPrefab;
    GameObject RightHand;
    GameObject RightHandPrefab;
    GameObject Avatar;
    GameObject AvatarPrefab;
    InteractorCollisionMode InteractorsCollisionMode;
    bool ForceRaycastEnabled;
    bool ForceRaycastOn;
    bool IsRaycastForcedOff;
    List<InteractableInfo> Interactables;
    List<InteractorInfo> Interactors;
    List<ILocomotionProvider> ActiveLocomotionProviders;
    AudioClip DefaultHoverEnterSound;
    AudioClip DefaultSelectEnterSound;
    AudioClip DefaultActivateEnterSound;
    float DefaultUIHoverEnterHapticIntensity;
    float DefaultHoverEnterHapticIntensity;
    float DefaultSelectEnterHapticIntensity;
    float DefaultActivateEnterHapticIntensity;
    bool AutomaticPlayerRigSetup;

    // methods

    void Startup();
    void Shutdown();
    virtual void UpdateModule(UpdatePhase updatePhase);

    virtual bool TryAddInteractable(
        GameObject gameObject,
        string interactableType,
        out IInteractable component
    );

    virtual IInteractable GetInteractable(
        GameObject gameObject,
        string interactableType
    );

    virtual IInteractable GetOrAddInteractable(
        GameObject gameObject,
        string interactableType
    );

    virtual IInteractable AddGrabbable(GameObject gameObject);
    virtual IInteractable GetGrabbable(GameObject gameObject);
    virtual IInteractable GetOrAddGrabbable(GameObject gameObject);

    virtual bool TryAddInteractor(
        GameObject gameObject,
        string interactorType,
        out IInteractor component
    );

    virtual IInteractor GetInteractor(GameObject gameObject, string interactorType);
    void ForceRaycast(bool enabled);
    void StopForceRaycast();

    virtual IInteractor GetOrAddInteractor(
        GameObject gameObject,
        string interactorType
    );

    string InteractionLayerToName(int layer);
    int NameToInteractionLayer(string name);

    void GetDefinedInteractionLayers(
        ref string[] layerNames,
        ref int[] layerBitMaskValues
    );

Detailed Documentation¶

The MAGES Interaction System module.

Properties¶

Material DefaultHoverMaterial

Gets the default hover material to be used for hovered interactables.

GameObject DefaultReticle

Gets the default reticle to use when hovering over interactables that do not provide their own.

HandTrackingAimPoseMode AimPoseMode

Gets the hand tracking aim pose mode.

GameObject DefaultTeleportReticle

Gets the default teleport reticle to use when hovering over teleportable areas.

GameObject OptionsMenu

Gets the error UI.

Methods¶

virtual override void UpdateModule(UpdatePhase updatePhase)

Called while the module is active.

Parameters:

updatePhase	The phase of the update.

virtual override bool TryAddInteractable(
    GameObject gameObject,
    string interactableType,
    out IInteractable component
)

Tries to add the given interactableType script to the gameObject.

Parameters:

gameObject	The gameobject to add the interactable to.
interactableType	The identifier name of the interactable type. See the scriptable object for all available types.
component	The IInteractable component added.

Returns:

true if it was possible to find the given interactableType type and add it to the gameObject.

virtual override IInteractable GetInteractable(
    GameObject gameObject,
    string interactableType
)

Gets the interactable of the given interactableType from the gameObject.

Parameters:

gameObject	The gameobject to get the component from.
interactableType	The type of the interactable to get.

Returns:

The interactable if found as IInteractable or null if it does not exist.

virtual override IInteractable GetOrAddInteractable(
    GameObject gameObject,
    string interactableType
)

Gets the interactable of the given interactableType from the gameObject. If the gameObject does not have this interactable type script, it will be added.

Parameters:

gameObject	The gameobject to get the component from or add it to.
interactableType	The type of the interactable to get or add.

Returns:

The interactable if found or added as IInteractable, or null if the interactableType given is invalid.

virtual override IInteractable AddGrabbable(GameObject gameObject)

Adds a Grabbable to the gameObject.

Parameters:

gameObject	The GameObject in which to add the Grabbable component.

Returns:

The added grabbable component.

virtual override IInteractable GetGrabbable(GameObject gameObject)

Gets the Grabbable from the gameObject.

Parameters:

gameObject	The GameObject to get the Grabbable from.

Returns:

The grabbable if found, else null.

virtual override IInteractable GetOrAddGrabbable(GameObject gameObject)

Adds a Grabbable to the gameObject or gets the one already on it.

This is the same as doing it with GetOrAddInteractable(GameObject, string), but is added extra to eliminate typo errors when using strings.

Parameters:

gameObject	The GameObject in which to add the Grabbable component.

Returns:

The Grabbable added or found, as IInteractable.

virtual override bool TryAddInteractor(
    GameObject gameObject,
    string interactorType,
    out IInteractor component
)

Tries to add the given interactorType script to the gameObject.

Parameters:

gameObject	The gameobject to add the interactor to.
interactorType	The identifier name of the interactor type. See the scriptable object for all available types.
component	The IInteractor component added.

Returns:

true if it was possible to find the given interactorType type and add it to the gameObject.

See also:

GetOrAddInteractor(GameObject, string)

virtual override IInteractor GetInteractor(
    GameObject gameObject,
    string interactorType
)

Gets the interactor of the given interactorType from the gameObject.

Parameters:

gameObject	The gameobject to get the component from.
interactorType	The type of the interactor to get.

Returns:

The interactor if found as IInteractor or null if it does not exist.

virtual override IInteractor GetOrAddInteractor(
    GameObject gameObject,
    string interactorType
)

Gets the interactor of the given interactorType from the gameObject. If the gameObject does not have this interactor type script, it will be added.

Parameters:

gameObject	The gameobject to get the component from or add it to.
interactorType	The type of the interactor to get or add.

Returns:

The interactor if found or added as IInteractor, or null if the interactorType given is invalid.