Humanoid Control for Unity v4
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Properties | List of all members
Passer.Tracking.SensorComponent Class Reference

Description

A sensor component is used to add tracking to a transform.

Custom sensor implementation can be made by deriving from this class.

Inheritance diagram for Passer.Tracking.SensorComponent:
Passer.Tracking.HandSkeleton Passer.Tracking.OculusHmd Passer.Tracking.ViveTrackerComponent Passer.Tracking.LeapHandSkeleton Passer.Tracking.OculusHandSkeleton Passer.Tracking.UnityXRHandSkeleton

Public Member Functions

virtual void Show (bool showModel)
 Show or hide the rendered model of the sensor.
 
virtual void StartComponent (Transform trackerTransform)
 Start the manual updating of the sensor.
 
virtual void UpdateComponent ()
 Update the component manually.
 

Public Attributes

Tracker.Status status
 The tracking status of the sensor.
 
float rotationConfidence
 The confidence (0..1) of the tracked rotation.
 
float positionConfidence
 The confidence (0..1) of the tracked position.
 
bool autoUpdate = true
 Is used to set whether the sensor updates itself.
 
GameObject model
 

Protected Member Functions

virtual void ShowModel (string resourceName)
 Try to add a rendered model to the sensor.
 
virtual void CreateModel (string resourceName)
 Add a rendered model to the sensor.
 
virtual void Awake ()
 Initializes the sensor.
 
virtual void Start ()
 Starts the sensor.
 

Protected Attributes

Transform trackerTransform
 The transform which is used as the root of the tracking space.
 
bool _show
 

Properties

virtual bool show [get, set]
 The render status of the sensor.
 
bool renderController [set]
 Enable or disable the renderers for this sensor.
 

Member Function Documentation

◆ ShowModel()

virtual void Passer.Tracking.SensorComponent.ShowModel ( string  resourceName)
protectedvirtual

Try to add a rendered model to the sensor.

Parameters
resourceNameThe name of the resource to use for the model

No new model is added when it already has a model

◆ CreateModel()

virtual void Passer.Tracking.SensorComponent.CreateModel ( string  resourceName)
protectedvirtual

Add a rendered model to the sensor.

Parameters
resourceNameThe name of the resource to use for the model

Any existing model will be destroyed and replaced.

◆ Show()

virtual void Passer.Tracking.SensorComponent.Show ( bool  showModel)
virtual

Show or hide the rendered model of the sensor.

Parameters
showModelTrue will show the mode, False will hide it

◆ Awake()

virtual void Passer.Tracking.SensorComponent.Awake ( )
protectedvirtual

Initializes the sensor.

When trackerTransform is null, it will be set automatically to the parent of this transform.

Reimplemented in Passer.Tracking.ViveTrackerComponent.

◆ Start()

virtual void Passer.Tracking.SensorComponent.Start ( )
protectedvirtual

Starts the sensor.

Does nothing at this moment.

Reimplemented in Passer.Tracking.HydraController, and Passer.Tracking.UnityXRHandSkeleton.

◆ StartComponent()

virtual void Passer.Tracking.SensorComponent.StartComponent ( Transform  trackerTransform)
virtual

Start the manual updating of the sensor.

Parameters
trackerTransform

When this function has been called, autoUpdate will be disabled and the sensor will no longer update from Unity Updates. Instead, UpdateComponent needs to be called to update the sensor data

◆ UpdateComponent()

virtual void Passer.Tracking.SensorComponent.UpdateComponent ( )
virtual

Member Data Documentation

◆ autoUpdate

bool Passer.Tracking.SensorComponent.autoUpdate = true

Is used to set whether the sensor updates itself.

When enabled, the sensor will update itself. When disabled, StartComponent and UpdateComponent need to be called to update the tracking status.

Property Documentation

◆ show

virtual bool Passer.Tracking.SensorComponent.show
getset

The render status of the sensor.

When enabled, sensors with renderers attached will be rendered. When disabled, sensors will not be rendered.


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