metaio::IUnifeyeMobileGeometry Class Reference

General interface for a 3D geometry that can be loaded within the system. More...

#include <AS_IUnifeyeMobileGeometry.h>

List of all members.

Public Member Functions
virtual BoundingBox	getBoundingBox ()=0
	Get the bounding box of the 3D geometry.
virtual int	getCos ()=0
	Get the ID of the cos that the 3D model is bound to.
virtual bool	getIsRendered ()=0
	Returns true if the geometry will be rendered by in this frame, else false.
virtual bool	getIsVisible ()=0
	Determine the visiblity of the 3D model.
virtual Vector4d	getMoveRotation ()=0
	Get the current rotation of the 3D model.
virtual Vector3d	getMoveScale ()=0
	Get the current scale of the 3D model.
virtual Vector3d	getMoveTranslation ()=0
	Get the current translation of the 3D model.
virtual LLACoordinate	getMoveTranslationLLA ()=0
	Determine the location of a geometry.
virtual Vector3d	getMoveTranslationLLACartesian ()=0
	Determine the Cartesian offset location of a geometry.
virtual bool	getSceneLighting ()=0
	Determine if the lighting for the 3D model is activated or deactivated.
virtual bool	getSceneShadingSmooth ()=0
	Determine if smooth shading is activated for the 3D model.
virtual bool	isType (UnifeyeMobileGeometryType geometryType)=0
	Returns true if the Geometry is of a given type.
virtual void	setAnimationSpeed (float fps)=0
	Set the animation speed of the model.
virtual void	setColor (const unsigned char R, const unsigned char G, const unsigned char B)=0
	Sets the color of the geometry.
virtual void	setCos (int cosID)=0
	Bind the 3D model to a specific cos.
virtual void	setLLALimitsEnabled (bool enabled)=0
	Activate or deactivate the usage of limits for updateMoveTranslationFromLLA.
virtual void	setMoveRotation (const Vector4d &rotation, bool concat=false)=0
	Set the rotation of the 3D model (Axis-Angle)
virtual void	setMoveRotation (const Vector3d &rotation, bool concat=false)=0
	Set the absolute rotation of the model in Euler angles form.
virtual void	setMoveScale (const Vector3d &scale, bool concat=false)=0
	Set the scale of the 3D model.
virtual void	setMoveTranslation (const Vector3d &translation, bool concat=false)=0
	Set the translation of the 3D model.
virtual void	setMoveTranslationLLA (LLACoordinate llaCoorindate)=0
	Set a GPS position for a geometry The system will then adjust its Cartesian offset in the renderer accordingly.
virtual void	setMovieTexture (const std::string &filename, const bool loop)=0
	Continuously set a h263 avi-movie's frames as texture for geometry.
virtual void	setOcclusionMode (bool occlude)=0
	Sets the occlusion mode of a geometry.
virtual void	setPickingEnabled (bool enabled)=0
	Enable or disable picking for a geometry.
virtual void	setSceneLighting (bool activated)=0
	Activate or deactivate lighting for the 3D model.
virtual void	setSceneShadingSmooth (bool shadeSmooth)=0
	Activate or Deactivate smooth shading for a 3D model.
virtual void	setText (const std::string text)=0
	sets the text string if there is one
virtual void	setTexture (const std::string &texturePath)=0
	Set image from given file path as texture for geometry.
virtual void	setTexture (const std::string &textureName, const ImageStruct &image)=0
	Specialized function to set texture from memory.
virtual void	setTransparency (unsigned char transparency)=0
	Set the transparency of an object.
virtual void	setVisible (bool visible)=0
	Set the 3D model visible or hide it.
virtual void	startAnimation (const std::string &animationName, bool loop)=0
	Start a specific animation of the 3D model.
virtual void	stopMovieTexture ()=0
	Stop the playback of a movie texture.

---

Detailed Description

General interface for a 3D geometry that can be loaded within the system.

---

Member Function Documentation

virtual BoundingBox metaio::IUnifeyeMobileGeometry::getBoundingBox

(

)

[pure virtual]

Get the bounding box of the 3D geometry.

Returns:

A vector containg the 6 bounding box values as follows: minX maxX minY maxY minZ maxZ

virtual int metaio::IUnifeyeMobileGeometry::getCos

(

)

[pure virtual]

Get the ID of the cos that the 3D model is bound to.

Returns:

the ID of the cos the 3D model is bound to

See also:

setCos

virtual bool metaio::IUnifeyeMobileGeometry::getIsRendered

(

)

[pure virtual]

Returns true if the geometry will be rendered by in this frame, else false.

Returns:

true if the geometry will be rendered this frame

virtual bool metaio::IUnifeyeMobileGeometry::getIsVisible

(

)

[pure virtual]

Determine the visiblity of the 3D model.

Returns:

true if visible, false otherwise

See also:

setVisible

virtual Vector4d metaio::IUnifeyeMobileGeometry::getMoveRotation

(

)

[pure virtual]

Get the current rotation of the 3D model.

Returns:

the rotation in axis angle representation (x, y, z, angle)

See also:

setMoveRotation

virtual Vector3d metaio::IUnifeyeMobileGeometry::getMoveScale

(

)

[pure virtual]

Get the current scale of the 3D model.

Returns:

the scale values (x, y, z)

See also:

setMoveScale

virtual Vector3d metaio::IUnifeyeMobileGeometry::getMoveTranslation

(

)

[pure virtual]

Get the current translation of the 3D model.

Returns:

the translation values (x, y, z)

See also:

setMoveTranslation

virtual LLACoordinate metaio::IUnifeyeMobileGeometry::getMoveTranslationLLA

(

)

[pure virtual]

Determine the location of a geometry.

Returns:

location of the geometry or its Cartesian offset, depending on the parameter

virtual Vector3d metaio::IUnifeyeMobileGeometry::getMoveTranslationLLACartesian

(

)

[pure virtual]

Determine the Cartesian offset location of a geometry.

Returns:

location of the geometry or its Cartesian offset, depending on the parameter

virtual bool metaio::IUnifeyeMobileGeometry::getSceneLighting

(

)

[pure virtual]

Determine if the lighting for the 3D model is activated or deactivated.

Returns:

true if lighting is activated, false otherwise

See also:

setSceneLighting

virtual bool metaio::IUnifeyeMobileGeometry::getSceneShadingSmooth

(

)

[pure virtual]

Determine if smooth shading is activated for the 3D model.

Returns:

true if smooth shading is activated, false otherwise

virtual bool metaio::IUnifeyeMobileGeometry::isType

(

UnifeyeMobileGeometryType

geometryType

)

[pure virtual]

Returns true if the Geometry is of a given type.

Parameters:

geometryType

the type of the geometry we ask for.

Returns:

True if the implementation of represents the given UnifeyeMobileGeometryType

virtual void metaio::IUnifeyeMobileGeometry::setAnimationSpeed

(

float

fps

)

[pure virtual]

Set the animation speed of the model.

Parameters:

fps	frames per second value

virtual void metaio::IUnifeyeMobileGeometry::setColor	(	const unsigned char	R,
		const unsigned char	G,
		const unsigned char	B
	)		[pure virtual]

Sets the color of the geometry.

Parameters:

R	red value
G	green value
B	float value

Returns:

void

virtual void metaio::IUnifeyeMobileGeometry::setCos

(

int

cosID

)

[pure virtual]

Bind the 3D model to a specific cos.

Parameters:

cosID

the id of the cos to bind to

See also:

getCos

virtual void metaio::IUnifeyeMobileGeometry::setLLALimitsEnabled

(

bool

enabled

)

[pure virtual]

Activate or deactivate the usage of limits for updateMoveTranslationFromLLA.

If disabled, the geometry will ignore the near and far limit passed in updateMoveTranslationFromLLA and always render the object the the real location. (default is true)

Parameters:

enabled

true to enable, false to disable

See also:

updateMoveTranslationFromLLA

virtual void metaio::IUnifeyeMobileGeometry::setMoveRotation	(	const Vector4d &	rotation,
		bool	concat = false
	)		[pure virtual]

Set the rotation of the 3D model (Axis-Angle)

Parameters:

rotation	rotation axis
concat	if true, new rotation is concatenated with existing rotation

See also:

getMoveRotation

virtual void metaio::IUnifeyeMobileGeometry::setMoveRotation	(	const Vector3d &	rotation,
		bool	concat = false
	)		[pure virtual]

Set the absolute rotation of the model in Euler angles form.

The rotation is on the lowest level and will be affected by all other rotations in the structure (like tracking or dragging). This rotation can be set by the user to compensate properties of the 3D model (e.g. a model lying on the side). It is given in Euler angles representation.

Parameters:

rotation	vector defining the rotation, x,y,z the Euler angles around each axis in radians
concat	if true, new rotation is concatenated with existing rotation

See also:

getMoveTranslation() and setMoveTranslation() for translating

getMoveScale() and setMoveScale() for scaling

getMoveRotation() and setMoveRotation() for rotating

virtual void metaio::IUnifeyeMobileGeometry::setMoveScale	(	const Vector3d &	scale,
		bool	concat = false
	)		[pure virtual]

Set the scale of the 3D model.

Parameters:

scale	scaling vector
concat	if true, new scale is multiplied with existing scale

See also:

getMoveScale

virtual void metaio::IUnifeyeMobileGeometry::setMoveTranslation	(	const Vector3d &	translation,
		bool	concat = false
	)		[pure virtual]

Set the translation of the 3D model.

Parameters:

translation	the translation vector
concat	if true, new translation is added to existing translation

See also:

getMoveTranslation

virtual void metaio::IUnifeyeMobileGeometry::setMoveTranslationLLA

(

LLACoordinate

llaCoorindate

)

[pure virtual]

Set a GPS position for a geometry The system will then adjust its Cartesian offset in the renderer accordingly.

Parameters:

llaCoorindate

latitude, longitude, altitude the position to set

See also:

getMoveTranslationLLA

virtual void metaio::IUnifeyeMobileGeometry::setMovieTexture	(	const std::string &	filename,
		const bool	loop
	)		[pure virtual]

Continuously set a h263 avi-movie's frames as texture for geometry.

Parameters:

filename	filename of h263 encoded avi-movie
loop	shall the movie get rendered in a loop

virtual void metaio::IUnifeyeMobileGeometry::setOcclusionMode

(

bool

occlude

)

[pure virtual]

Sets the occlusion mode of a geometry.

Parameters:

occlude

true, if the object should act as occlusion geometry

Returns:

void

virtual void metaio::IUnifeyeMobileGeometry::setPickingEnabled

(

bool

enabled

)

[pure virtual]

Enable or disable picking for a geometry.

This method will modify the renderer bit mask for the model. All objects with bit mask 1 will be used for picking, others not

Parameters:

enabled

true to enable picking, false to disable

virtual void metaio::IUnifeyeMobileGeometry::setSceneLighting

(

bool

activated

)

[pure virtual]

Activate or deactivate lighting for the 3D model.

Parameters:

activated

true to activate, false to deactivate

See also:

getSceneLighting

virtual void metaio::IUnifeyeMobileGeometry::setSceneShadingSmooth

(

bool

shadeSmooth

)

[pure virtual]

Activate or Deactivate smooth shading for a 3D model.

Parameters:

shadeSmooth

true to activate, false to deactivate

See also:

getSceneShadingSmooth

virtual void metaio::IUnifeyeMobileGeometry::setTexture	(	const std::string &	textureName,
		const ImageStruct &	image
	)		[pure virtual]

Specialized function to set texture from memory.

Parameters:

textureName	name that should be assigned to the texture (for reuse).
image	image content

virtual void metaio::IUnifeyeMobileGeometry::setTexture

(

const std::string &

texturePath

)

[pure virtual]

Set image from given file path as texture for geometry.

Parameters:

texturePath

path to the texture image file.

virtual void metaio::IUnifeyeMobileGeometry::setTransparency

(

unsigned char

transparency

)

[pure virtual]

Set the transparency of an object.

Parameters:

transparency

the transparency value

Returns:

void

virtual void metaio::IUnifeyeMobileGeometry::setVisible

(

bool

visible

)

[pure virtual]

Set the 3D model visible or hide it.

Parameters:

visible

true to show the 3D model, false to hide it

See also:

getIsVisible

virtual void metaio::IUnifeyeMobileGeometry::startAnimation	(	const std::string &	animationName,
		bool	loop
	)		[pure virtual]

Start a specific animation of the 3D model.

Parameters:

animationName	Identifier of the animation
loop	should the animation be looped