Represents an item in a scene that is purely text.

#include <Rendering/SceneComponents/annotation.h>

Inheritance diagram for Annotation:

Public Member Functions
	Annotation (const Annotation &)

	Annotation (const QString &id="")

	~Annotation () override

Annotation *	clone () const override

const Mesh::Vector3d &	getCoordinates () const

bool	getEnabled () const

const QString &	getText () const

bool	isOverlay () const

Annotation &	operator= (const Annotation &annotation)

void	setCoordinates (const Mesh::Vector3d &coordinates)

void	setEnabled (bool b)

void	setIsOverlay (bool b)

void	setText (const QString &text)

bool	visit (SceneItemProcessor &processor) override

Public Member Functions inherited from SceneItem
	~SceneItem () override

SceneItem *	clone () const override=0

bool	getEnabled () const

const QString &	getId () const

const Mesh::BoundingBoxMinimal &	getLocalBoundingBox () const

virtual Mesh::TransformMatrix	getMatrixGlobal () const

virtual Mesh::TransformMatrix	getMatrixLocal () const

const QString &	getName () const

Mesh::TransformMatrix	getParentMatrixGlobal () const

Transform *	getParentTransform ()

void	setEnabled (bool b)

void	setId (const QString &itemId)

virtual void	setLocalBoundingBox (const Mesh::BoundingBoxMinimal &bb)

void	setName (const QString &name)

virtual Transform *	toTransform ()

virtual const Transform *	toTransform () const

virtual void	updateGlobalMatrix ()

virtual bool	visit (SceneItemProcessor &processor)=0

Public Member Functions inherited from Observable
virtual	~Observable ()

void	attachObserver (Observer &observer)

void	destroy ()

void	detachObserver (Observer &observer)

void	notifyEvent (const ObservableEvent &event)

Public Member Functions inherited from Clonable
virtual	~Clonable ()=default

virtual Clonable *	clone () const =0

Additional Inherited Members
Protected Member Functions inherited from SceneItem
	SceneItem (const QString &id)

	SceneItem (const SceneItem &item)

virtual void	addToScene (Scene &scene, const QString &opIdPath="")

bool	isTransformModified () const

SceneItem &	operator= (const SceneItem &item)

void	setTransformModified (bool b)

Protected Member Functions inherited from Observable
	Observable ()

	Observable (const Observable &)

Constructor & Destructor Documentation

◆ Annotation() [1/2]

Annotation ( const QString & id = "" )

◆ Annotation() [2/2]

Annotation ( const Annotation & other )

◆ ~Annotation()

~Annotation ( )

override

Member Function Documentation

◆ clone()

Annotation * clone ( ) const

overridevirtual

Returns: A clone of this object.

Note: Subclasses would normally return their own type rather than the Clonable type. The C++ language rules allow a more derived type to be returned from a virtual function and the compiler will still treat it as a valid override.

Implements SceneItem.

◆ getCoordinates()

const Vector3d & getCoordinates ( ) const

◆ getEnabled()

bool getEnabled ( ) const

◆ getText()

const QString & getText ( ) const

◆ isOverlay()

bool isOverlay ( ) const

Returns: true if the annotation is to be overlaid on the scene, false if it is to be embedded in the scene. If overlaid, the annotation will not be occluded by objects in the scene.

◆ operator=()

Annotation & operator= ( const Annotation & annotation )

◆ setCoordinates()

void setCoordinates ( const Mesh::Vector3d & coordinates )

◆ setEnabled()

void setEnabled ( bool b )

◆ setIsOverlay()

void setIsOverlay ( bool b )

Parameters

b	Set to true to overlay the annotation on top of the scene. Set to false to embed the annotation within the scene.

See also: isOverlay

◆ setText()

void setText ( const QString & text )

◆ visit()

bool visit ( SceneItemProcessor & processor )