[Home]	[About]
[Screenshots]	[Download]
[News]	[Community]
[Documentation]	[Manual]
[Bugs & Requests]	[Wiki]

A3DL::Viewpoint Class Reference
[libmetaobject_a3dl]

#include <vos/metaobjects/a3dl/viewpoint.hh>

Inheritance diagram for A3DL::Viewpoint:

List of all members.

---

Detailed Description

A viewpoint is some position and orientation in space that a user may wish to assume.

The recommended "starting positoin" in a sector is represented by a viewpoint object named "default-viewpoint". Additionaly, viewpoints may suggest an angular "field of view" for rendering the world.

Definition at line 42 of file viewpoint.hh.

Public Member Functions

• Viewpoint (VOS::VobjectBase *superobject)
• virtual ~Viewpoint ()
• virtual void setPosition (double x, double y, double z)

  Set position of this viewpoint.
  

• virtual void getPosition (double &x, double &y, double &z)

  Get position of this viewpoint.
  

• virtual void setOrientation (double x, double y, double z, double r)

  The orientation of this viewpoint in angle-axis representation.
  

• virtual void getOrientation (double &x, double &y, double &z, double &r)

  The orientation of this viewpoint in angle-axis representation.
  

• virtual void setFOV (double angle)

  Set viewpoint field of view.
  

• virtual double getFOV ()

  Get viewpoint field of view.
  

• virtual void setTitle (const std::string &text)

  Set the viewpoint's title.
  

• virtual std::string getTitle ()

  Get the viewpoint's title.
  

• virtual void initialize ()

  Initialize subproperties: position=(0,0,0), orientaiont=(0,0,0), viewpoint:fov and viewpoint:title are unset.
  

• virtual const std::string getVOSType ()

Static Public Member Functions

• static VOS::MetaObject * new_Viewpoint (VOS::VobjectBase *superobject, const std::string &type)

---

Constructor & Destructor Documentation

A3DL::Viewpoint::Viewpoint

(

VOS::VobjectBase *

superobject

)

virtual A3DL::Viewpoint::~Viewpoint

(

)

[virtual]

---

Member Function Documentation

virtual double A3DL::Viewpoint::getFOV

(

)

[virtual]

Get viewpoint field of view.

Returns:

the viewpoint field of view

Exceptions:

NoSuchObjectError

if "viewpoint:fov" subobject does not exist, or is not a property.

virtual void A3DL::Viewpoint::getOrientation	(	double &	x,
		double &	y,
		double &	z,
		double &	r
	)			[virtual]

The orientation of this viewpoint in angle-axis representation.

See A3DL::Object3D::getOrientation() for details

virtual void A3DL::Viewpoint::getPosition	(	double &	x,
		double &	y,
		double &	z
	)			[virtual]

Get position of this viewpoint.

Parameters:

	x	X translation, relative to origin of parent object
	y	Y translation, relative to origin of parent object
	z	Z translation, relative to origin of parent object

Exceptions:

NoSuchObjectError

if "position" subobject does not exist, or is not a property.

virtual std::string A3DL::Viewpoint::getTitle

(

)

[virtual]

Get the viewpoint's title.

virtual const std::string A3DL::Viewpoint::getVOSType

(

)

[virtual]

Returns:

the specific VOS type name that represents the VOS interface this object is supplying. This should always be overridden by the subclass.

Reimplemented from VOS::MetaObject.

virtual void A3DL::Viewpoint::initialize

(

)

[virtual]

Initialize subproperties: position=(0,0,0), orientaiont=(0,0,0), viewpoint:fov and viewpoint:title are unset.

Warning:

sets No access control by default!

static VOS::MetaObject* A3DL::Viewpoint::new_Viewpoint	(	VOS::VobjectBase *	superobject,
		const std::string &	type
	)			[static]

virtual void A3DL::Viewpoint::setFOV

(

double

angle

)

[virtual]

Set viewpoint field of view.

Parameters:

angle

View angle in radians. PI > angle > 0

Exceptions:

NoSuchObjectError

if "viewpoint:fov" subobject does not exist, or is not a property.

virtual void A3DL::Viewpoint::setOrientation	(	double	x,
		double	y,
		double	z,
		double	r
	)			[virtual]

The orientation of this viewpoint in angle-axis representation.

See A3DL::Object3D::setOrientation() for details

virtual void A3DL::Viewpoint::setPosition	(	double	x,
		double	y,
		double	z
	)			[virtual]

Set position of this viewpoint.

Parameters:

	x	X translation, relative to origin of parent object
	y	Y translation, relative to origin of parent object
	z	Z translation, relative to origin of parent object

Exceptions:

NoSuchObjectError

if "position" subobject does not exist, or is not a property.

virtual void A3DL::Viewpoint::setTitle

(

const std::string &

text

)

[virtual]

Set the viewpoint's title.

Parameters:

text

Title in plain text.

---

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

• /home/tetron/hack/vos/libs/vos/metaobjects/a3dl/viewpoint.hh