Documentation for the Unity C# Library
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
PixoVR.Event.InteractableClass Class Referenceabstract

s Base class for interactable objects with which the step manager interacts. It also stores a set of basic functions More...

Inheritance diagram for PixoVR.Event.InteractableClass:
[legend]

Public Member Functions

virtual void ActivateSetCallback (Action callback)
 Waiting for object activation.
 
virtual void Active (bool state)
 
virtual void Awake ()
 
virtual void CheckInspectionStatus ()
 
virtual void Execute ()
 Used to indicate to the step manager that some actions were performed on the object.
 
virtual void GenerateBreakdown (int percentBroke)
 Generate a breakdown on the object with a certain probability.
 
virtual void HideModel ()
 Disable parts of some object childs models. Useful for configuring object breakdowns.
 
virtual void Highlight (bool state)
 Highlight an object.
 
virtual void Interactive (bool state)
 
virtual void OnTimerExpired ()
 
virtual void OpenInspectionMenu (string quizId)
 Enable inpection menu UI.
 
virtual void PlayForwardAnimation (bool playForward, Action callback)
 Used to play an animation and wait for it to finish.
 
virtual void PrepareInspectionReport (List< InteractableClass > interactables)
 
virtual void RepairElement ()
 Remove from the broken state object.
 
virtual void SetDefaultState ()
 Restoring the original state of an object after any actions with it.
 
virtual void SetInspected ()
 
virtual void SetParametersForItem (string value, string[] additionalValues)
 
void SetTimer (float timer)
 Loops and infinitely runs a method after some time in seconds.
 
virtual void ShowModel ()
 Enable parts of some object childs models. Useful for configuring object breakdowns.
 
void StopTimer ()
 Stop loops and infinitely runs a method.
 
virtual void TurnOffWaitForSelection ()
 Disable waiting for object highlighting with a pointer or hand approach. Mainly used in eval fashion.
 
virtual void TurnOnOffState (bool turnOn)
 
virtual void WaitForSelection ()
 Highlight the object with a pointer or hand approach. Mainly used in evaluation mode.
 

Public Attributes

int BrokenId = 0
 
bool IsActive
 
bool IsBroken
 
bool isInspected = false
 
ItemsEnum ItemId
 
ItemsEnum[] StepsId
 

Protected Member Functions

void SetGrabEnabled (bool isEnabled)
 
void ShowModels ()
 

Protected Attributes

DistanceGrabbable _distanceGrabbable
 [SerializeField]
 
Grabbable[] _grabbables
 
GameObject[] brokenModels
 [SerializeField]
 
GameObject[] correctModels
 [SerializeField]
 

Private Member Functions

void OnStartTargeting (Hand hand, Grabbable grabbable)
 
void OnStopTargeting (Hand hand, Grabbable grabbable)
 
IEnumerator StartTimer (float timer)
 

Private Attributes

Outline[] _additionalOutlines
 [SerializeField]
 
Outline _outline
 [SerializeField]
 
Coroutine _timerCoroutine
 
bool _waitingForSelection
 

Static Private Attributes

const int MaxValue = 100
 
const int MinValue = 1
 

Detailed Description

s Base class for interactable objects with which the step manager interacts. It also stores a set of basic functions

Definition at line 17 of file InteractableClass.cs.

Member Function Documentation

◆ ActivateSetCallback()

virtual void PixoVR.Event.InteractableClass.ActivateSetCallback ( Action callback)
inlinevirtual

Waiting for object activation.

Parameters
callback

Definition at line 281 of file InteractableClass.cs.

◆ Active()

virtual void PixoVR.Event.InteractableClass.Active ( bool state)
inlinevirtual

Definition at line 69 of file InteractableClass.cs.

Here is the caller graph for this function:

◆ Awake()

virtual void PixoVR.Event.InteractableClass.Awake ( )
inlinevirtual

Reimplemented in PixoVR.Event.SimpleInteractable.

Definition at line 64 of file InteractableClass.cs.

◆ CheckInspectionStatus()

virtual void PixoVR.Event.InteractableClass.CheckInspectionStatus ( )
inlinevirtual

Definition at line 324 of file InteractableClass.cs.

Here is the call graph for this function:

◆ Execute()

virtual void PixoVR.Event.InteractableClass.Execute ( )
inlinevirtual

Used to indicate to the step manager that some actions were performed on the object.

Reimplemented in PixoVR.Event.ItemOnClick.

Definition at line 267 of file InteractableClass.cs.

Here is the caller graph for this function:

◆ GenerateBreakdown()

virtual void PixoVR.Event.InteractableClass.GenerateBreakdown ( int percentBroke)
inlinevirtual

Generate a breakdown on the object with a certain probability.

Parameters
percentBroke

Reimplemented in PixoVR.Event.BreakableInteractable< TBreakType >.

Definition at line 249 of file InteractableClass.cs.

Here is the caller graph for this function:

◆ HideModel()

virtual void PixoVR.Event.InteractableClass.HideModel ( )
inlinevirtual

Disable parts of some object childs models. Useful for configuring object breakdowns.

Definition at line 216 of file InteractableClass.cs.

◆ Highlight()

virtual void PixoVR.Event.InteractableClass.Highlight ( bool state)
inlinevirtual

Highlight an object.

Parameters
state

Reimplemented in PixoVR.Event.ItemOnClick.

Definition at line 101 of file InteractableClass.cs.

Here is the caller graph for this function:

◆ Interactive()

virtual void PixoVR.Event.InteractableClass.Interactive ( bool state)
inlinevirtual
Parameters
state

Reimplemented in PixoVR.Event.QuizDisplay, PixoVR.Event.ItemOnClick, and PixoVR.Event.SimpleInteractable.

Definition at line 58 of file InteractableClass.cs.

Here is the call graph for this function:

◆ OnStartTargeting()

void PixoVR.Event.InteractableClass.OnStartTargeting ( Hand hand,
Grabbable grabbable )
inlineprivate

Definition at line 179 of file InteractableClass.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ OnStopTargeting()

void PixoVR.Event.InteractableClass.OnStopTargeting ( Hand hand,
Grabbable grabbable )
inlineprivate

Definition at line 184 of file InteractableClass.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ OnTimerExpired()

virtual void PixoVR.Event.InteractableClass.OnTimerExpired ( )
inlinevirtual

Definition at line 380 of file InteractableClass.cs.

Here is the caller graph for this function:

◆ OpenInspectionMenu()

virtual void PixoVR.Event.InteractableClass.OpenInspectionMenu ( string quizId)
inlinevirtual

Enable inpection menu UI.

Parameters
quizId

Reimplemented in PixoVR.Event.QuizDisplay, and PixoVR.Event.QuizInteractable.

Definition at line 193 of file InteractableClass.cs.

◆ PlayForwardAnimation()

virtual void PixoVR.Event.InteractableClass.PlayForwardAnimation ( bool playForward,
Action callback )
inlinevirtual

Used to play an animation and wait for it to finish.

Parameters
playForward
callback

Definition at line 259 of file InteractableClass.cs.

◆ PrepareInspectionReport()

virtual void PixoVR.Event.InteractableClass.PrepareInspectionReport ( List< InteractableClass > interactables)
inlinevirtual

Definition at line 229 of file InteractableClass.cs.

◆ RepairElement()

virtual void PixoVR.Event.InteractableClass.RepairElement ( )
inlinevirtual

Remove from the broken state object.

Definition at line 296 of file InteractableClass.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetDefaultState()

virtual void PixoVR.Event.InteractableClass.SetDefaultState ( )
inlinevirtual

Restoring the original state of an object after any actions with it.

Definition at line 241 of file InteractableClass.cs.

◆ SetGrabEnabled()

void PixoVR.Event.InteractableClass.SetGrabEnabled ( bool isEnabled)
inlineprotected

Definition at line 308 of file InteractableClass.cs.

◆ SetInspected()

virtual void PixoVR.Event.InteractableClass.SetInspected ( )
inlinevirtual

Definition at line 303 of file InteractableClass.cs.

Here is the caller graph for this function:

◆ SetParametersForItem()

virtual void PixoVR.Event.InteractableClass.SetParametersForItem ( string value,
string[] additionalValues )
inlinevirtual

Reimplemented in PixoVR.Event.QuizDisplay.

Definition at line 233 of file InteractableClass.cs.

◆ SetTimer()

void PixoVR.Event.InteractableClass.SetTimer ( float timer)
inline

Loops and infinitely runs a method after some time in seconds.

Parameters
timer

Definition at line 345 of file InteractableClass.cs.

Here is the call graph for this function:

◆ ShowModel()

virtual void PixoVR.Event.InteractableClass.ShowModel ( )
inlinevirtual

Enable parts of some object childs models. Useful for configuring object breakdowns.

some

Definition at line 200 of file InteractableClass.cs.

◆ ShowModels()

void PixoVR.Event.InteractableClass.ShowModels ( )
inlineprotected

Definition at line 77 of file InteractableClass.cs.

Here is the caller graph for this function:

◆ StartTimer()

IEnumerator PixoVR.Event.InteractableClass.StartTimer ( float timer)
inlineprivate

Definition at line 370 of file InteractableClass.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ StopTimer()

void PixoVR.Event.InteractableClass.StopTimer ( )
inline

Stop loops and infinitely runs a method.

Definition at line 360 of file InteractableClass.cs.

Here is the caller graph for this function:

◆ TurnOffWaitForSelection()

virtual void PixoVR.Event.InteractableClass.TurnOffWaitForSelection ( )
inlinevirtual

Disable waiting for object highlighting with a pointer or hand approach. Mainly used in eval fashion.

Definition at line 154 of file InteractableClass.cs.

Here is the call graph for this function:

◆ TurnOnOffState()

virtual void PixoVR.Event.InteractableClass.TurnOnOffState ( bool turnOn)
inlinevirtual
Parameters
turnOn

Definition at line 289 of file InteractableClass.cs.

Here is the caller graph for this function:

◆ WaitForSelection()

virtual void PixoVR.Event.InteractableClass.WaitForSelection ( )
inlinevirtual

Highlight the object with a pointer or hand approach. Mainly used in evaluation mode.

Definition at line 126 of file InteractableClass.cs.

Here is the call graph for this function:

Member Data Documentation

◆ _additionalOutlines

Outline [] PixoVR.Event.InteractableClass._additionalOutlines
privateSerializeField

[SerializeField]

Definition at line 40 of file InteractableClass.cs.

◆ _distanceGrabbable

DistanceGrabbable PixoVR.Event.InteractableClass._distanceGrabbable
protectedSerializeField

[SerializeField]

Definition at line 44 of file InteractableClass.cs.

◆ _grabbables

Grabbable [] PixoVR.Event.InteractableClass._grabbables
protected

Definition at line 49 of file InteractableClass.cs.

◆ _outline

Outline PixoVR.Event.InteractableClass._outline
privateSerializeField

[SerializeField]

Definition at line 36 of file InteractableClass.cs.

◆ _timerCoroutine

Coroutine PixoVR.Event.InteractableClass._timerCoroutine
private

Definition at line 52 of file InteractableClass.cs.

◆ _waitingForSelection

bool PixoVR.Event.InteractableClass._waitingForSelection
private

Definition at line 50 of file InteractableClass.cs.

◆ BrokenId

int PixoVR.Event.InteractableClass.BrokenId = 0

Definition at line 22 of file InteractableClass.cs.

◆ brokenModels

GameObject [] PixoVR.Event.InteractableClass.brokenModels
protectedSerializeField

[SerializeField]

Definition at line 32 of file InteractableClass.cs.

◆ correctModels

GameObject [] PixoVR.Event.InteractableClass.correctModels
protectedSerializeField

[SerializeField]

Definition at line 28 of file InteractableClass.cs.

◆ IsActive

bool PixoVR.Event.InteractableClass.IsActive

Definition at line 20 of file InteractableClass.cs.

◆ IsBroken

bool PixoVR.Event.InteractableClass.IsBroken

Definition at line 21 of file InteractableClass.cs.

◆ isInspected

bool PixoVR.Event.InteractableClass.isInspected = false

Definition at line 23 of file InteractableClass.cs.

◆ ItemId

ItemsEnum PixoVR.Event.InteractableClass.ItemId

Definition at line 19 of file InteractableClass.cs.

◆ MaxValue

const int PixoVR.Event.InteractableClass.MaxValue = 100
staticprivate

Definition at line 47 of file InteractableClass.cs.

◆ MinValue

const int PixoVR.Event.InteractableClass.MinValue = 1
staticprivate

Definition at line 46 of file InteractableClass.cs.

◆ StepsId

ItemsEnum [] PixoVR.Event.InteractableClass.StepsId

Definition at line 24 of file InteractableClass.cs.

The documentation for this class was generated from the following file: