The PathViewpoint animates the viewpoint position and orientation based on a specified path. More...

#include <PathViewpoint.hh>

Inheritance diagram for gramods::gmGraphics::PathViewpoint:

[legend]

Collaboration diagram for gramods::gmGraphics::PathViewpoint:

[legend]

Classes
struct	Impl

Public Member Functions
void	setPath (std::vector< Pose > path)
	Sets the path of the viewpoint.

void	addNode (const Pose &node)
	Adds a single node to the path of the viewpoint.

void	setLoop (bool on)
	Sets whether the viewpoint should loop over the path or not.

void	setExit (bool on)
	Activates or deactivates automatic exit when the path has been covered.

void	setVelocity (float v)
	Sets the velocity over the path, in meters per second.

void	update (clock::time_point time, size_t frame) override
	Updates the animation.

Public Member Functions inherited from gramods::gmGraphics::Viewpoint
virtual Eigen::Vector3f	getPosition (Eye eye=Eye::MONO)
	Returns the position of the viewpoint.

virtual Eigen::Quaternionf	getOrientation (Eye eye=Eye::MONO)
	Returns the orientation of the viewpoint.

virtual void	setPosition (Eigen::Vector3f p)
	Explicitly sets the position of the Viewpoint.

void	setEyeSeparation (float e)
	Sets the distance between the eyes for stereoscopic (or multiscopic) rendering, in internal units, typically meters.

virtual void	setOrientation (Eigen::Quaternionf q)
	Explicitly sets the orientation of the Viewpoint.

virtual void	setUpDirection (Eigen::Vector3f up)
	Set the up direction to be used in a later call to setLookAt.

virtual void	setLookAt (Eigen::Vector3f p)
	Sets a point that the viewpoint should be rotated towards.

virtual void	unsetLookAt ()
	Unsets the look-at point so that the viewpoint orientation is no longer automatically rotated.

virtual std::string	getDefaultKey () override
	Returns the default key, in Configuration, for the Object.

Public Member Functions inherited from gramods::gmCore::Object
	Object ()
	Initializes internal data.

virtual	~Object ()
	Cleaning up internal data.

virtual void	initialize ()
	Called to initialize the Object.

virtual void	accept (Visitor *visitor)
	Calls the visitors apply method with this as argument.

virtual void	traverse (Visitor *visitor)
	Calls the child Object's accept method, if such exist.

bool	isInitialized ()
	Returns true if the Object is initialized.

Public Member Functions inherited from gramods::gmCore::Updateable
	Updateable (int priority=0)
	Configures the Updateable properties to the specified priority.

Static Public Attributes
static gramods::gmCore::OFactory::OFactoryInformation	_gm_ofi

Static Public Attributes inherited from gramods::gmGraphics::Viewpoint
static gramods::gmCore::OFactory::OFactoryInformation	_gm_ofi

Additional Inherited Members
Public Types inherited from gramods::gmCore::Updateable
typedef std::chrono::steady_clock	clock

Static Public Member Functions inherited from gramods::gmCore::Updateable
static void	updateAll (clock::time_point t=clock::now(), std::optional< size_t > frame=std::nullopt)
	Updates all currently instanciated updateable objects.

Protected Attributes inherited from gramods::gmGraphics::Viewpoint
Eigen::Vector3f	position = Eigen::Vector3f::Zero()

Eigen::Quaternionf	orientation = Eigen::Quaternionf::Identity()

Eigen::Vector3f	up_direction = Eigen::Vector3f(0, 1, 0)

std::optional< Eigen::Vector3f >	look_at

float	eye_separation = 0.06f

Detailed Description

The PathViewpoint animates the viewpoint position and orientation based on a specified path.

Member Function Documentation

◆ addNode()

void gramods::gmGraphics::PathViewpoint::addNode ( const Pose & node )

Adds a single node to the path of the viewpoint.

XML-attribute: node

See also: gramods::operator>>(std::istream &, Pose &)

◆ setExit()

void gramods::gmGraphics::PathViewpoint::setExit ( bool on )

Activates or deactivates automatic exit when the path has been covered.

Default is false.

XML-attribute: exit

◆ setLoop()

void gramods::gmGraphics::PathViewpoint::setLoop ( bool on )

Sets whether the viewpoint should loop over the path or not.

Default is true.

XML-attribute: loop

◆ setPath()

void gramods::gmGraphics::PathViewpoint::setPath ( std::vector< Pose > path )

Sets the path of the viewpoint.

XML-attribute: path

See also: gramods::operator>>(std::istream &, std::vector<Pose> &)

◆ setVelocity()

void gramods::gmGraphics::PathViewpoint::setVelocity ( float v )

Sets the velocity over the path, in meters per second.

Default is 1 m/s.

XML-attribute: velocity

◆ update()

void gramods::gmGraphics::PathViewpoint::update	(	clock::time_point	time,
		size_t	frame
	)

overridevirtual

Updates the animation.

Implements gramods::gmCore::Updateable.

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

/home/karlu/private/program/gramods/modules/gmGraphics/include/gmGraphics/PathViewpoint.hh
/home/karlu/private/program/gramods/modules/gmGraphics/src/PathViewpoint.cpp

Classes

Public Member Functions

Static Public Attributes

Additional Inherited Members