Class ArucoObjectDisplayer

Inheritance
Object
ArucoObjectDisplayer
ArucoObjectCreator
Namespace: ArucoUnity.Objects.Displayers
Assembly: Assembly-CSharp.dll
Syntax
public class ArucoObjectDisplayer : MonoBehaviour

Fields

| Improve this Doc View Source

imagePlaneMaterial

Declaration
protected Material imagePlaneMaterial
Field Value
Type Description
Material
| Improve this Doc View Source

lastArucoObjectOnValidate

Declaration
protected ArucoObject lastArucoObjectOnValidate
Field Value
Type Description
ArucoObject

Properties

| Improve this Doc View Source

ArucoObject

Get or sets the ArUco object to display.

Declaration
protected ArucoObject ArucoObject { get; set; }
Property Value
Type Description
ArucoObject
| Improve this Doc View Source

DisplayInPlayMode

Gets or sets if ImagePlane is displayed in play mode.

Declaration
protected bool DisplayInPlayMode { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

Image

Gets the image of the ArucoObject to display.

Declaration
public Cv.Mat Image { get; protected set; }
Property Value
Type Description
Cv.Mat
| Improve this Doc View Source

ImagePlane

Gets the plane that display ImageTexture.

Declaration
public GameObject ImagePlane { get; protected set; }
Property Value
Type Description
GameObject
| Improve this Doc View Source

ImagePlanePrefab

Gets or sets the prefab of ImagePlane. If null, default will be loaded: Prefabs/Resources/ArucoCreatorImagePlane.prefab.

Declaration
public GameObject ImagePlanePrefab { get; set; }
Property Value
Type Description
GameObject
| Improve this Doc View Source

ImageTexture

Gets the texture that contains Image.

Declaration
public Texture2D ImageTexture { get; protected set; }
Property Value
Type Description
Texture2D

Methods

| Improve this Doc View Source

ArucoObject_PropertyUpdated(ArucoObject)

Calls UpdateImage().

Declaration
protected virtual void ArucoObject_PropertyUpdated(ArucoObject arucoObject)
Parameters
Type Name Description
ArucoObject arucoObject
| Improve this Doc View Source

CreateImage()

Creates Image and ImageTexture from ArucoObject.

Declaration
public virtual void CreateImage()
| Improve this Doc View Source

DisplayImage()

Updates ImagePlane with ImageTexture.

Declaration
public virtual void DisplayImage()
| Improve this Doc View Source

InitializeImagePlane()

Initializes ImagePlane.

Declaration
protected virtual void InitializeImagePlane()
| Improve this Doc View Source

OnDestroy()

Unsubscribes from the PropertyUpdated event.

Declaration
protected virtual void OnDestroy()
| Improve this Doc View Source

PlaceImagePlane()

Places, rotates and scales the image plane.

Declaration
protected virtual void PlaceImagePlane()
| Improve this Doc View Source

ResetImage()

Resets Image, ImageTexture and ImagePlane.

Declaration
public virtual void ResetImage()
| Improve this Doc View Source

SetArucoObject(ArucoObject)

Subscribes to the PropertyUpdated event, and unsubscribes from the previous ArucoObject.

Declaration
protected virtual void SetArucoObject(ArucoObject arucoObject)
Parameters
Type Name Description
ArucoObject arucoObject
| Improve this Doc View Source

Start()

Calls SetArucoObject(ArucoObject) to display the ArucoObject only in play mode.

Declaration
protected virtual void Start()
| Improve this Doc View Source

Update()

Updates the display in the editor if ArucoObject has been changed.

Declaration
protected virtual void Update()
| Improve this Doc View Source

UpdateImage()

Calls CreateImage() then DisplayImage() if Image has been created or ResetImage().

Declaration
protected virtual void UpdateImage()