Handles camera matrix files. More...

#include <VGearsCameraMatrixFile.h>

Inheritance diagram for VGears::CameraMatrixFile:

Collaboration diagram for VGears::CameraMatrixFile:

[legend]

Public Member Functions
	CameraMatrixFile (Ogre::ResourceManager creator, const String &name, Ogre::ResourceHandle handle, const String &group, bool is_manual=false, Ogre::ManualResourceLoader loader=NULL)
	Constructor. More...

virtual	~CameraMatrixFile ()
	Destructor. More...

const Ogre::Matrix3 &	GetMatrix () const
	Retrieves the camera matrix in the file. More...

void	SetMatrix (const Ogre::Matrix3 &matrix)
	Sets the camera matrix. More...

const Ogre::Vector3 &	GetPosition () const
	Retrieves the camera position. More...

void	SetPosition (const Ogre::Vector3 &position)
	Sets the camera position. More...

const Pixel &	GetOffset () const
	Retrieves the camera offset. More...

void	SetOffset (const Pixel &offset)
	Sets the camera offset. More...

const size_t &	GetCount () const
	Counts the ??? More...

void	SetCount (const size_t count)
	Sets the number of ??? More...

const Ogre::Real &	GetFocalLength () const
	Retrieves the focal length. More...

void	SetFocalLength (const Ogre::Real focal_length)
	Sets the focal length. More...

Ogre::Quaternion	GetOrientation () const
	Retrieves the camera orientation. More...

Ogre::Radian	GetFov (Ogre::Real width) const
	Retrieves the camera field of view. More...

Public Member Functions inherited from VGears::Resource
	Resource (Ogre::ResourceManager creator, const String &name, Ogre::ResourceHandle handle, const String &group, bool manual, Ogre::ManualResourceLoader loader)
	Constructor. More...

virtual	~Resource ()=default
	Destructor. More...

Static Public Attributes
static const String	RESOURCE_TYPE
	The type of resource. More...

Protected Member Functions
virtual void	loadImpl (void)
	Loads the file. More...

virtual void	unloadImpl (void)
	Unloads the file. More...

virtual size_t	CalculateSize (void) const
	Calculates the file size. More...

Protected Member Functions inherited from VGears::Resource
virtual Ogre::DataStreamPtr	openResource ()
	Opens the resource. More...

Private Attributes
Ogre::Matrix3	matrix_
	The camera matrix. More...

Ogre::Vector3	position_
	The position of the camera. More...

Pixel	offset_
	The camera offset. More...

Ogre::Real	focal_length_
	The focal length. More...

size_t	count_
	The number of. More...

Detailed Description

Handles camera matrix files.

Constructor & Destructor Documentation

◆ CameraMatrixFile()

VGears::CameraMatrixFile::CameraMatrixFile	(	Ogre::ResourceManager *	creator,
		const String &	name,
		Ogre::ResourceHandle	handle,
		const String &	group,
		bool	is_manual = `false`,
		Ogre::ManualResourceLoader *	loader = `NULL`
	)

Constructor.

Parameters

[in]	creator	Pointer to the ResourceManager that is creating this resource.
[in]	name	The unique name of the resource.
[in]	handle

Todo:: Understand and document.

Parameters

[in]	group	The name of the resource group to which this resource belong.
[in]	is_manual	True if the resource is manually loaded, false otherwise.
[in]	loader	Pointer to a ManualResourceLoader implementation which will be called when the Resource wishes to load (should be supplied if is_manual is set to true). It can be null, but the Resource will never be able to reload if anything ever causes it to unload. Therefore provision of a proper ManualResourceLoader instance is strongly recommended.

◆ ~CameraMatrixFile()

VGears::CameraMatrixFile::~CameraMatrixFile ( )

virtual

Destructor.

Member Function Documentation

◆ CalculateSize()

size_t VGears::CameraMatrixFile::CalculateSize ( void ) const

protectedvirtual

Calculates the file size.

Returns: Always 0.

◆ GetCount()

const size_t & VGears::CameraMatrixFile::GetCount ( ) const

Counts the ???

Returns: The number of ???

Todo:: What does this count?

◆ GetFocalLength()

const Ogre::Real & VGears::CameraMatrixFile::GetFocalLength ( ) const

Retrieves the focal length.

Returns: The focal length.

◆ GetFov()

Ogre::Radian VGears::CameraMatrixFile::GetFov ( Ogre::Real width ) const

Retrieves the camera field of view.

Returns: The field of view.

◆ GetMatrix()

const Ogre::Matrix3 & VGears::CameraMatrixFile::GetMatrix ( ) const

Retrieves the camera matrix in the file.

Returns: The camera matrix.

◆ GetOffset()

const Pixel & VGears::CameraMatrixFile::GetOffset ( ) const

Retrieves the camera offset.

Returns: The camera offset, as a {

See also: Pixel}.

◆ GetOrientation()

Ogre::Quaternion VGears::CameraMatrixFile::GetOrientation ( ) const

Retrieves the camera orientation.

Returns: The camera orientation.

◆ GetPosition()

const Ogre::Vector3 & VGears::CameraMatrixFile::GetPosition ( ) const

Retrieves the camera position.

Returns: The camera position.

◆ loadImpl()

void VGears::CameraMatrixFile::loadImpl ( void )

protectedvirtual

Loads the file.

◆ SetCount()

void VGears::CameraMatrixFile::SetCount ( const size_t count )

Sets the number of ???

Parameters

[in] count The number of ???

Todo:: What is this number?

◆ SetFocalLength()

void VGears::CameraMatrixFile::SetFocalLength ( const Ogre::Real focal_length )

Sets the focal length.

Parameters

[in] focal_length The focal length.

◆ SetMatrix()

void VGears::CameraMatrixFile::SetMatrix ( const Ogre::Matrix3 & matrix )

Sets the camera matrix.

Parameters

[in] matrix The camera matrix.

◆ SetOffset()

void VGears::CameraMatrixFile::SetOffset ( const Pixel & offset )

Sets the camera offset.

Parameters

[in] offset The camera offset, as a {

See also: Pixel}.

◆ SetPosition()

void VGears::CameraMatrixFile::SetPosition ( const Ogre::Vector3 & position )

Sets the camera position.

Parameters

[in] position The camera position.

◆ unloadImpl()

void VGears::CameraMatrixFile::unloadImpl ( void )

protectedvirtual

Unloads the file.

Member Data Documentation

◆ count_

size_t VGears::CameraMatrixFile::count_

private

The number of.

Todo:: what?

◆ focal_length_

Ogre::Real VGears::CameraMatrixFile::focal_length_

private

The focal length.

◆ matrix_

Ogre::Matrix3 VGears::CameraMatrixFile::matrix_

private

The camera matrix.

◆ offset_

Pixel VGears::CameraMatrixFile::offset_

private

The camera offset.

◆ position_

Ogre::Vector3 VGears::CameraMatrixFile::position_

private

The position of the camera.

◆ RESOURCE_TYPE

const String VGears::CameraMatrixFile::RESOURCE_TYPE

static

The type of resource.

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

src/data/VGearsCameraMatrixFile.h
src/data/VGearsCameraMatrixFile.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CameraMatrixFile()

◆ ~CameraMatrixFile()

Member Function Documentation

◆ CalculateSize()

◆ GetCount()

◆ GetFocalLength()

◆ GetFov()

◆ GetMatrix()

◆ GetOffset()

◆ GetOrientation()

◆ GetPosition()

◆ loadImpl()

◆ SetCount()

◆ SetFocalLength()

◆ SetMatrix()

◆ SetOffset()

◆ SetPosition()

◆ unloadImpl()

Member Data Documentation

◆ count_

◆ focal_length_

◆ matrix_

◆ offset_

◆ position_

◆ RESOURCE_TYPE