#include <goviewplane.h>

Public Member Functions
	goViewPlane (goViewPlane &other)

go3Vector< volFloat > &	getPosition ()

go3Vector< volFloat > &	getSize ()

go3Vector< volFloat > &	getScreenSize ()

void	setEyePos (go3Vector< volFloat > &p)

void	setSize (go3Vector< volFloat > &s)

void	setScreenSize (go3Vector< volFloat > &s)

void	setScreenSize (goInt32 x, goInt32 y)
	For convenience. See setScreenSize(go3Vector<volFloat>& s)

void	setSize (volFloat x, volFloat y)

void	setEyePos (volFloat x, volFloat y, volFloat z)

void	setPixelWidth (volFloat d)

void	setPixelHeight (volFloat d)

volFloat	getPixelWidth ()

volFloat	getPixelHeight ()

go3Vector< volFloat > &	getNormal ()

const go3Vector< volFloat > &	getNormal () const

void	setNormal (go3Vector< volFloat > &v)

go3Vector< volFloat > &	getUp ()

const go3Vector< volFloat > &	getUp () const

void	setUp (go3Vector< volFloat > &u)

void	setEyeDistance (volFloat f)

volFloat	getEyeDistance () const

virtual void	operator= (goViewPlane &other)

const go44Matrix< volFloat > &	getViewMatrix () const

const go44Matrix< volFloat > &	getViewMatrix ()

void	update ()

go3Vector< volFloat > &	getU ()

go3Vector< volFloat > &	getV ()

go3Vector< volFloat > &	getEyePos ()

void	calculateUpperLeft (go3Vector< volFloat > &ul)

void	calculateUpperRight (go3Vector< volFloat > &ur)

void	calculateLowerLeft (go3Vector< volFloat > &ll)

void	calculateLowerRight (go3Vector< volFloat > &lr)

void	scale (volFloat factor)

void	rotate (volFloat angle, Vol::GO_ROTATION_AXIS ax)

Public Member Functions inherited from goObjectBase
	goObjectBase ()
	Constructor.

virtual	~goObjectBase ()
	Destructor. More...

const char *	getClassName () const
	Returns the class name. More...

int	getClassID () const

virtual goSize_t	memoryUsage () const
	Returns the size of this object or some measure of its memory consumption. More...

void	setObjectName (const char *name)
	Set name string for an object. More...

void	setObjectName (const goString &name)
	Set name string for an object. More...

const goString &	getObjectName () const
	Get the object name. More...

virtual bool	writeObjectFile (FILE *) const
	Write object to a file. More...

virtual bool	readObjectFile (FILE *)
	Read object from a file. More...

void	connectObject (goObjectBase *object)
	Connects an object to this object. More...

void	disconnectObject (const goObjectBase *object)
	Disconnects an object from this object.

virtual bool	callObjectMethod (int methodID, goObjectMethodParameters *param=NULL)
	Call an object method by identifier. More...

virtual bool	queueObjectMethod (int methodID, goObjectMethodParameters *param=NULL, bool blocking=false)
	Enqueue a method call to an internal list of methods. More...

bool	callQueuedMethods ()
	Call all queued methods. More...

Protected Attributes
go3Vector< volFloat >	normal

go3Vector< volFloat >	up

volFloat	rotAngleX

volFloat	rotAngleY

volFloat	rotAngleZ

go3Vector< volFloat >	position

go3Vector< volFloat >	size

go3Vector< volFloat >	screenSize

go3Vector< volFloat >	u

go3Vector< volFloat >	v

volFloat	pixelWidth

volFloat	pixelHeight

volFloat	eyeDistance

go3Vector< volFloat >	eyePos

go44Matrix< volFloat >	Tproj

Additional Inherited Members
Protected Member Functions inherited from goObjectBase
void	setClassID (int id)
	Sets the class name.

void	printClassMessage (const char *msg)
	Sets the class name. More...

void	printClassMessage (goString &msg)
	Prints an informational message to the calling console. More...

void	sendObjectMessage (int messageID, void *data=NULL)
	Sends a message to all connected objects.

void	sendObjectMessage (goObjectBase object, int messageID, void data=NULL)
	Sends a message to a specific object.

virtual void	receiveObjectMessage (const goObjectMessage &message)
	Receive a message. More...

Detailed Description

Storage class for the parameters describing a view plane in 3D space.

Author: Christian Gosch

Member Function Documentation

◆ calculateLowerLeft()

void goViewPlane::calculateLowerLeft ( go3Vector< volFloat > & ll )

See also: calculateUpperLeft

Parameters

ll	Reference to a go3Vector in which the coordinates are stored.

◆ calculateLowerRight()

void goViewPlane::calculateLowerRight ( go3Vector< volFloat > & lr )

See also: calculateUpperLeft

Parameters

lr	Reference to a go3Vector in which the coordinates are stored.

◆ calculateUpperLeft()

void goViewPlane::calculateUpperLeft ( go3Vector< volFloat > & ul )

Calculates the upper left "visible" corner on the view plane in coordinates relative to the world coordinate system (NOT the view coordinate system!)

Parameters

ul	Reference to a go3Vector in which the coordinates are stored.

◆ calculateUpperRight()

void goViewPlane::calculateUpperRight ( go3Vector< volFloat > & ur )

See also: calculateUpperLeft

Parameters

ur	Reference to a go3Vector in which the coordinates are stored.

◆ getEyeDistance()

volFloat goViewPlane::getEyeDistance ( ) const

inline

Returns: The eye distance from the eye position to the principal point of this viewplane, in world coordinate units.

◆ getNormal()

go3Vector<volFloat>& goViewPlane::getNormal ( )

inline

Returns: Plane normal of the viewplane.

◆ getPixelHeight()

volFloat goViewPlane::getPixelHeight ( )

inline

Returns: Height of one screen pixel in world coordinate units.

◆ getPixelWidth()

volFloat goViewPlane::getPixelWidth ( )

inline

Returns: Width of one screen pixel in world coordinate units.

◆ getPosition()

go3Vector<volFloat>& goViewPlane::getPosition ( )

inline

Returns: Principal point of the view plane in world coordinates. This is the point in the middle of the view plane.

◆ getScreenSize()

go3Vector<volFloat>& goViewPlane::getScreenSize ( )

inline

Returns: The intended screen size for this viewplane in pixels.

◆ getSize()

go3Vector<volFloat>& goViewPlane::getSize ( )

inline

Returns: The size of the view plane in pixels. Only the x and y members of the returned vector are valid.

◆ getUp()

go3Vector<volFloat>& goViewPlane::getUp ( )

inline

Returns: The up-vector of this viewplane.

◆ getViewMatrix()

const go44Matrix<volFloat>& goViewPlane::getViewMatrix ( ) const

Returns: The 4x4 view matrix for this viewplane.

◆ operator=()

virtual void goViewPlane::operator= ( goViewPlane & other )

virtual

Copies the properties of another viewplane into this one. You should call update() after a call to operator=.

Parameters

other Viewplane to be copied from.

◆ scale()

void goViewPlane::scale ( volFloat factor )

inline

Scales all scalable values with factor. Call update() afterwards.

Parameters

factor double Factor to multiplicate with.

◆ setEyeDistance()

void goViewPlane::setEyeDistance ( volFloat f )

inline

Sets the eye distance, that is the distance from the eye position to the principal point of the viewplane, in world coordinate units.

Parameters

f	Eye distance.

◆ setEyePos()

void goViewPlane::setEyePos ( go3Vector< volFloat > & p )

inline

Sets the eye position for the view.

Parameters

p	Vector which contains the new eye position.

◆ setNormal()

void goViewPlane::setNormal ( go3Vector< volFloat > & v )

inline

Sets the plane normal of the view plane.

Parameters

v	Plane normal.

◆ setPixelHeight()

void goViewPlane::setPixelHeight ( volFloat d )

inline

Sets the height of one pixel in world coordinate units. Used to calculate the screen size when you set the size of the viewplane itself.

Parameters

d	Height of one screen pixel in world coordinate units.

◆ setPixelWidth()

void goViewPlane::setPixelWidth ( volFloat d )

inline

Sets the with of one pixel in world coordinate units. Used to calculate the screen size when you set the size of the viewplane itself.

Parameters

d	Width of one screen pixel in world coordinate units.

◆ setScreenSize()

void goViewPlane::setScreenSize ( go3Vector< volFloat > & s )

inline

Sets the intended screen size for this viewplane in pixels.

◆ setSize() [1/2]

void goViewPlane::setSize ( go3Vector< volFloat > & s )

inline

Sets the size of the view plane in pixels. Only the x and y components of the parameter are valid.

Parameters

s	Size of the view plane.

◆ setSize() [2/2]

void goViewPlane::setSize	(	volFloat	x,
		volFloat	y
	)

inline

Size only has a meaning if you want it to. You could, for example, use the size of the screen to calculate some size of your plane. Or, you might just want to set it to one. Or whatever.

◆ setUp()

void goViewPlane::setUp ( go3Vector< volFloat > & u )

inline

Sets the up-vector of the view plane, that is the vector that points upwards from the viewer.

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

goviewplane.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ calculateLowerLeft()

◆ calculateLowerRight()

◆ calculateUpperLeft()

◆ calculateUpperRight()

◆ getEyeDistance()

◆ getNormal()

◆ getPixelHeight()

◆ getPixelWidth()

◆ getPosition()

◆ getScreenSize()

◆ getSize()

◆ getUp()

◆ getViewMatrix()

◆ operator=()

◆ scale()

◆ setEyeDistance()

◆ setEyePos()

◆ setNormal()

◆ setPixelHeight()

◆ setPixelWidth()

◆ setScreenSize()

◆ setSize() [1/2]

◆ setSize() [2/2]

◆ setUp()