MaxstAR Unity
Public Member Functions | Protected Member Functions | Properties | List of all members
maxstAR.AbstractTrackableBehaviour Class Reference

Parent class of all TrackableBehaviour. Save tracking file's id (uuid), name, path etc. All setting datas are for editor mode and runtime tracking result. More...

Inheritance diagram for maxstAR.AbstractTrackableBehaviour:
maxstAR.AbstractImageTrackableBehaviour maxstAR.AbstractInstantTrackableBehaviour maxstAR.AbstractMarkerTrackableBehaviour maxstAR.AbstractObjectTrackableBehaviour maxstAR.AbstractQrCodeTrackableBehaviour

Public Member Functions

virtual void OnTrackFail ()
 Common interface to notify this target lost tracking. Child class can override this method to receive tracking lost event More...
 
virtual void OnTrackSuccess (string id, string name, Matrix4x4 poseMatrix)
 Common interface to notify this target tracking success. Child class can override this method to receive tracking success event More...
 

Protected Member Functions

virtual void OnTrackerDataFileChanged (string trackerFileName)
 To notify tracker file changed (Editor mode only) More...
 

Properties

StorageType StorageType [get, set]
 If file is located in android assets folder or not More...
 
UnityEngine.Object TrackerDataFileObject [get, set]
 Save tracking file object name in StreamingAssets folder (For editor mode) More...
 
string TrackerDataFileName [get, set]
 Tracking file name More...
 
string TrackableId [get, set]
 Tracking file uuid. This value is addressed in tracking file. More...
 
string TrackableName [get, set]
 Tracking file name only without extention. More...
 

Detailed Description

Parent class of all TrackableBehaviour. Save tracking file's id (uuid), name, path etc. All setting datas are for editor mode and runtime tracking result.

Member Function Documentation

◆ OnTrackerDataFileChanged()

virtual void maxstAR.AbstractTrackableBehaviour.OnTrackerDataFileChanged ( string  trackerFileName)
protectedvirtual

To notify tracker file changed (Editor mode only)

Parameters
trackerFileName

Reimplemented in maxstAR.AbstractImageTrackableBehaviour, maxstAR.AbstractQrCodeTrackableBehaviour, maxstAR.AbstractMarkerTrackableBehaviour, and maxstAR.AbstractObjectTrackableBehaviour.

◆ OnTrackFail()

virtual void maxstAR.AbstractTrackableBehaviour.OnTrackFail ( )
virtual

Common interface to notify this target lost tracking. Child class can override this method to receive tracking lost event

◆ OnTrackSuccess()

virtual void maxstAR.AbstractTrackableBehaviour.OnTrackSuccess ( string  id,
string  name,
Matrix4x4  poseMatrix 
)
virtual

Common interface to notify this target tracking success. Child class can override this method to receive tracking success event

Parameters
idtarget's id (uuid)
nametarget's name (map file name without extension)
poseMatrixtracked pose matrix

Property Documentation

◆ StorageType

StorageType maxstAR.AbstractTrackableBehaviour.StorageType
getset

If file is located in android assets folder or not

◆ TrackableId

string maxstAR.AbstractTrackableBehaviour.TrackableId
getset

Tracking file uuid. This value is addressed in tracking file.

◆ TrackableName

string maxstAR.AbstractTrackableBehaviour.TrackableName
getset

Tracking file name only without extention.

◆ TrackerDataFileName

string maxstAR.AbstractTrackableBehaviour.TrackerDataFileName
getset

Tracking file name

◆ TrackerDataFileObject

UnityEngine.Object maxstAR.AbstractTrackableBehaviour.TrackerDataFileObject
getset

Save tracking file object name in StreamingAssets folder (For editor mode)


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