HingeEngageableObject Class

An engageable object that uses Unity's Hinge/Joint components

Inheritance Hierarchy

SystemObject
  UnityEngine.Object
    UnityEngine.Component
      UnityEngine.Behaviour
        UnityEngine.MonoBehaviour
          ImmerseSDKLoggingBehaviour
            ImmerseSDK.IndexingIndexedMonoBehaviour
              ImmerseSDK.InteractionEngageableObject
                ImmerseSDK.InteractionHingeEngageableObject
                  ImmerseSDK.InteractionDial
                  ImmerseSDK.InteractionDoor
                  ImmerseSDK.InteractionLever

Namespace: ImmerseSDK.Interaction
Assembly: ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.5.0.0 (3.5.0.0)

Syntax

public abstract class HingeEngageableObject : EngageableObject

The HingeEngageableObject type exposes the following members.

Constructors

	Name	Description
	HingeEngageableObject	Initializes a new instance of the HingeEngageableObject class

Properties

	Name	Description
	Joint	The Joint associated with this hinge
	JointAnchor	The joint anchor position in world coordinates
	Sensitivity	Sensitivity of movement that is applied (acts like a dampener). Note this is applied to both angular movement and positional movement. (Overrides EngageableObjectSensitivity.)

Methods

	Name	Description
	Awake	Unity component method (Overrides EngageableObjectAwake.)
	GetAverageDirectionOfMovementForPositionUpdate	Default direction is from interaction point to controller (Overrides EngageableObjectGetAverageDirectionOfMovementForPositionUpdate.)
	GetDirectionOfMovementForPositionUpdate	Default direction is from interaction point to controller (Overrides EngageableObjectGetDirectionOfMovementForPositionUpdate(Int32).)
	IsMovementVelocityValid	Checks whether the vector passed in is valid - checks for Nan, and that it's magnitude is greater than Mathf.Epsilon (Overrides EngageableObjectIsMovementVelocityValid(Vector3).)
	OnDrawGizmos	Unity Component Method (Overrides EngageableObjectOnDrawGizmos.)
	RestrictPosition	Restrict position so that hinge cannot be moved (Overrides EngageableObjectRestrictPosition(Vector3).)
	SetInteractionTargets	Sets the interaction target on the controller (Overrides EngageableObjectSetInteractionTargets(Controller).)

Fields

	Name	Description
	_sensitivity	Sensitivity of movement that is applied (acts like a dampener). Note this is applied to both angular movement and positional movement.

Extension Methods

	Name	Description
	GetCopyOf	Copies all properties of a component from source to target. Uses reflection to set properties. (Defined by ComponentExtensions.)
	GetObjectIndex	Gets the index from the IndexedMonoBehaviour (Defined by GUID.)
	GetOwner	Gets the owner id from the IndexedMonoBehaviour (Defined by GUID.)
	GetOwnerType	Gets the owner type from the IndexedMonoBehaviour (Defined by GUID.)
	GetScene	Gets the scene id from the IndexedMonoBehaviour (Defined by GUID.)
	WaitForT	Waits for a singleton on a coroutine (Defined by SingletonManager.)