C++ Java Unity
Unity Reference
CylinderTargetBehaviour Class Reference

This class serves both as an augmentation definition for a CylinderTarget in the editor as well as a tracked CylinderTarget result at runtime More...

Inheritance diagram for CylinderTargetBehaviour:
DataSetTrackableBehaviour TrackableBehaviour WorldCenterTrackableBehaviour VuforiaMonoBehaviour

Public Member Functions

override void OnFrameIndexUpdate (int newFrameIndex)
 Is triggered by the StateManager after each render frame More...
 
bool SetBottomDiameter (float value)
 
bool SetSideLength (float value)
 
bool SetTopDiameter (float value)
 
- Public Member Functions inherited from TrackableBehaviour
virtual void OnTrackerUpdate (Status newStatus, StatusInfo newStatusInfo)
 Is triggered by the TrackerBehavior after it has updated. More...
 
void RegisterTrackableEventHandler (ITrackableEventHandler trackableEventHandler)
 This method registers a new Tracker event handler at the Tracker. These handlers are called as soon as ALL Trackables have been updated in this frame. More...
 
bool UnregisterTrackableEventHandler (ITrackableEventHandler trackableEventHandler)
 This method unregisters a Tracker event handler. Returns "false" if event handler does not exist. More...
 

Protected Member Functions

override bool CorrectScaleImpl ()
 Scales the Trackable uniformly More...
 
override void InternalUnregisterTrackable ()
 This method disconnects the TrackableBehaviour from it's associated trackable. Use it only if you know what you are doing - e.g. when you want to destroy a trackable, but reuse the TrackableBehaviour. More...
 
- Protected Member Functions inherited from DataSetTrackableBehaviour
virtual void Awake ()
 
- Protected Member Functions inherited from TrackableBehaviour
bool EnforceUniformScaling ()
 Scales the Trackable uniformly More...
 
virtual bool SetScale (Vector3 size)
 Set scale-value of this game object based on one dimension. The largest dimension is used as scale value. More...
 
bool SetScaleFromHeight (float height, float aspectRatio)
 Set scale-value of this game object based on the target height. This method should be used only for 2D-targets More...
 
bool SetScaleFromWidth (float width, float aspectRatio)
 Set scale-value of this game object based on the target width. This method should be used only for 2D-targets More...
 

Properties

float BottomDiameter [get]
 Get or set the bottom diameter. Changing this value uniformly scales the target. More...
 
CylinderTarget CylinderTarget [get]
 The CylinderTarget that this CylinderTargetBehaviour augments More...
 
float SideLength [get]
 Get or set the sidelength (slanted height). Changing this value uniformly scales the target. More...
 
float TopDiameter [get]
 Get or set the top diameter. Changing this value uniformly scales the target. More...
 
- Properties inherited from TrackableBehaviour
Status CurrentStatus [get]
 The tracking status of the TrackableBehaviour More...
 
StatusInfo CurrentStatusInfo [get]
 Information on the tracking status. Gives the primary reason about the problem with tracking (STATUS::NO_POSE or STATUS::LIMITED). More...
 
virtual Trackable Trackable [get]
 The Trackable created at runtime that is augmented by this TrackableBehaviour More...
 
string TrackableName [get]
 The name of the Trackable. More...
 
- Properties inherited from WorldCenterTrackableBehaviour
Trackable Trackable [get]
 The Trackable created at runtime that is augmented by this TrackableBehaviour More...
 

Additional Inherited Members

- Public Types inherited from TrackableBehaviour
enum  Status {
  NO_POSE = 0,
  LIMITED = 1,
  DETECTED = 2,
  TRACKED = 3,
  EXTENDED_TRACKED = 4
}
 The tracking status of the TrackableBehaviour. More...
 
enum  StatusInfo {
  NORMAL = 0,
  UNKNOWN = 1,
  INITIALIZING = 2,
  RELOCALIZING = 3,
  EXCESSIVE_MOTION = 4,
  INSUFFICIENT_FEATURES = 5,
  INSUFFICIENT_LIGHT = 6,
  NO_DETECTION_RECOMMENDING_GUIDANCE = 7
}
 Information on the tracking status. Gives the primary reason about the problem with tracking (STATUS::NO_POSE or STATUS::LIMITED). More...
 
- Protected Attributes inherited from DataSetTrackableBehaviour
string mDataSetPath = ""
 
- Protected Attributes inherited from TrackableBehaviour
bool mInitializedInEditor = false
 
bool mPreserveChildSize = false
 
Vector3 mPreviousScale = Vector3.zero
 This value is used to identify non-uniform scaling of the trackable. More...
 
Status mStatus = Status.NO_POSE
 
StatusInfo mStatusInfo = StatusInfo.UNKNOWN
 
Trackable mTrackable
 
string mTrackableName = ""
 For dataset-trackables this value is retrieved from the dataset and it is used for detecting that the specified trackable in the dataset is not valid anymore. More...
 

Detailed Description

This class serves both as an augmentation definition for a CylinderTarget in the editor as well as a tracked CylinderTarget result at runtime

Member Function Documentation

override bool CorrectScaleImpl ( )
protectedvirtual

Scales the Trackable uniformly

Reimplemented from TrackableBehaviour.

override void InternalUnregisterTrackable ( )
protectedvirtual

This method disconnects the TrackableBehaviour from it's associated trackable. Use it only if you know what you are doing - e.g. when you want to destroy a trackable, but reuse the TrackableBehaviour.

Implements TrackableBehaviour.

override void OnFrameIndexUpdate ( int  newFrameIndex)
virtual

Is triggered by the StateManager after each render frame

Parameters
newFrameIndexFrame index of processed frame, multiple render frames can have the same frame index

Reimplemented from TrackableBehaviour.

bool SetBottomDiameter ( float  value)
bool SetSideLength ( float  value)
bool SetTopDiameter ( float  value)

Property Documentation

float BottomDiameter
get

Get or set the bottom diameter. Changing this value uniformly scales the target.

float SideLength
get

Get or set the sidelength (slanted height). Changing this value uniformly scales the target.

float TopDiameter
get

Get or set the top diameter. Changing this value uniformly scales the target.