Foundry::Katana::Render::CameraSettings Class Reference

A utility class which provides Katana's camera settings by parsing attribute data on camera scene graph locations. This class can be extended if renderer specific processing is required. More...

#include <CameraSettings.h>

List of all members.

Public Member Functions
	CameraSettings (Foundry::Katana::FnScenegraphIterator iterator, const std::string &cameraName="")
virtual int	initialise (int displayWindow[4], int overscan[4], float shutterClose=0.0f)
std::string	getName () const
std::string	getProjection () const
float	getFov () const
void	getClipping (float clipping[2]) const
void	getScreenWindow (float screenWindow[4]) const
std::vector < FnRenderOutputUtils::RenderOutputUtils::Transform >	getTransforms () const

---

Detailed Description

A utility class which provides Katana's camera settings by parsing attribute data on camera scene graph locations. This class can be extended if renderer specific processing is required.

Note:

Where applicable, the getter functions refer to the camera settings attribute on the camera scene graph location.

---

Constructor & Destructor Documentation

Foundry::Katana::Render::CameraSettings::CameraSettings	(	Foundry::Katana::FnScenegraphIterator	iterator,
		const std::string &	cameraName = ""
	)		[inline]

Parameters:

iterator	The root scene graph iterator
cameraName	The camera scene graph location name (/root/cam/[cameraName])

---

Member Function Documentation

void Foundry::Katana::Render::CameraSettings::getClipping

(

float

clipping[2]

)

const

Returns:

The camera's clipping plane (near, far) (geometry.near and geometry.far)

float Foundry::Katana::Render::CameraSettings::getFov

(

)

const [inline]

Returns:

The camera's field of view (geometry.fov)

std::string Foundry::Katana::Render::CameraSettings::getName

(

)

const [inline]

Returns:

The camera's scene graph location name.

std::string Foundry::Katana::Render::CameraSettings::getProjection

(

)

const [inline]

Returns:

The camera's projection, e.g. 'perspective' (geometry.projection)

void Foundry::Katana::Render::CameraSettings::getScreenWindow

(

float

screenWindow[4]

)

const

Returns:

The camera's screen window (left, right, bottom, top)

std::vector<FnRenderOutputUtils::RenderOutputUtils::Transform> Foundry::Katana::Render::CameraSettings::getTransforms

(

)

const [inline]

Returns:

The camera's transform (inverse xform attribute list)

virtual int Foundry::Katana::Render::CameraSettings::initialise	(	int	displayWindow[4],
		int	overscan[4],
		float	shutterClose = 0.0f
	)		[virtual]

Handles the camera attribute parsing

Parameters:

displayWindow	The display window (affects the camera's screen window)
overscan	The overscan (affects the camera's screen window)
shutterClose	Shutter close (used to calculate the camera's transforms)

Returns:

A zero value if successful, a non-zero value otherwise

---

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

• CameraSettings.h