PlaneGeometry contains information for projection of graphics on a plane. More...

#include <PlaneGeometry.hh>

Inheritance diagram for gramods::gmGraphics::PlaneGeometry:

[legend]

Collaboration diagram for gramods::gmGraphics::PlaneGeometry:

[legend]

Classes
struct	Impl

Public Member Functions
void	setPosition (Eigen::Vector3f p)
	Set the position of the plane. More...

void	setNormal (Eigen::Vector3f n)
	Set the orientation of the plane by defining its normal. More...

void	setOrientation (Eigen::Quaternionf q)
	Set the orientation of the plane. More...

bool	getCameraFromPosition (Camera vfrustum, Eigen::Vector3f position, Camera &rfrustum) override
	Calculates and returns a frustum, with optical center at the specified position, that contains the intersection between the provided frustum and the geometrical shape. More...

std::string	getIntersectionCode () override
	Returns shader code that implements the necessary functions for the specific Geometry. More...

void	setMapperUniforms (GLuint program) override
	Called by the code that is using this geometry object, to let the it set the uniforms used by the mapper code. More...

Public Member Functions inherited from gramods::gmGraphics::Geometry
	Geometry (Impl *_impl=nullptr)

void	setInside (bool on)
	Set true if the projection should be calculated for the inside of the geometry, and not the outside. More...

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

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

virtual	~Object ()
	Cleaning up internal data. More...

virtual void	initialize ()
	Called to initialize the Object. More...

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

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

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

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

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

Additional Inherited Members
Protected Attributes inherited from gramods::gmGraphics::Geometry
std::unique_ptr< Impl >	_impl

Detailed Description

PlaneGeometry contains information for projection of graphics on a plane.

This can be used to compensate for keystoning.

Member Function Documentation

◆ getCameraFromPosition()

bool gramods::gmGraphics::PlaneGeometry::getCameraFromPosition	(	Camera	vfrustum,
		Eigen::Vector3f	position,
		Camera &	rfrustum
	)

overridevirtual

Calculates and returns a frustum, with optical center at the specified position, that contains the intersection between the provided frustum and the geometrical shape.

Parameters

[in]	vfrustum	The view frustum, typically the frustum of a projector that projects onto a geometrical surface.
[in]	position	The rendering position, that will be the position of the returned render frustum.
[out]	rfrustum	The render frustum, a frustum that will provide a rendering of the scene, from the provided position, onto the geometry where this geometry is seen by the vfrustum frustum.

Returns: True if a camera could be specified and false if there is no valid camera that fulfills the requirements.

Reimplemented from gramods::gmGraphics::Geometry.

◆ getIntersectionCode()

std::string gramods::gmGraphics::PlaneGeometry::getIntersectionCode ( )

overridevirtual

Returns shader code that implements the necessary functions for the specific Geometry.

The code implements

vec3 getIntersection(vec3 pos, vec3 dir) - returns the intersection between the line defined by the specified position and direction vector and the PlaneGeometry. Return (0,0,0) if there is no intersection.

Reimplemented from gramods::gmGraphics::Geometry.

◆ setMapperUniforms()

void gramods::gmGraphics::PlaneGeometry::setMapperUniforms ( GLuint program )

overridevirtual

Called by the code that is using this geometry object, to let the it set the uniforms used by the mapper code.

Reimplemented from gramods::gmGraphics::Geometry.

◆ setNormal()

void gramods::gmGraphics::PlaneGeometry::setNormal ( Eigen::Vector3f n )

Set the orientation of the plane by defining its normal.

XML-attribute: normal

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

◆ setOrientation()

void gramods::gmGraphics::PlaneGeometry::setOrientation ( Eigen::Quaternionf q )

Set the orientation of the plane.

The zero rotation plane is in the x-y plane.

XML-attribute: orientation

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

◆ setPosition()

void gramods::gmGraphics::PlaneGeometry::setPosition ( Eigen::Vector3f p )

Set the position of the plane.

XML-attribute: position

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

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

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

Classes

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getCameraFromPosition()

◆ getIntersectionCode()

◆ setMapperUniforms()

◆ setNormal()

◆ setOrientation()

◆ setPosition()