#include <camerainfo.h>

Inheritance diagram for lwpp::CameraInfo:

Collaboration diagram for lwpp::CameraInfo:

Public Member Functions
	CameraInfo (LWItemID _camera=LWITEM_NULL)
	Constructor.
unsigned int	antiAliasing (LWTime time)
double	blurLength (LWTime time)
void	diaphragm (LWTime time, int sides, double rotation)
bool	evenFirst ()
unsigned int	fieldRendering ()
void	filmSize (double width, double height)
unsigned int	flags ()
	Returns the flags of the camera.
double	focalDistance (LWTime time)
double	focalLength (LWTime time)
void	fovAngles (LWTime time, double hfov, double vfov)
bool	frameTiming (LWFrame frame, LWFrameTimingInfo *timingInfo)
double	fStop (LWTime time)
LWItemID	getID () const
	Returns the LWItemID of the camera.
bool	hasDOF ()
	Returns a boolean value indicating if the camera has Depth of Field active.
bool	hasLimitedRegion ()
	Returns a boolean value indicating if the camera has a Limited Region active.
bool	hasMask ()
	Returns a boolean value indicating if the camera has a Mask active.
bool	hasNoLRBorders ()
	Returns a boolean value indicating if the camera use a Limited Region without borders.
bool	hasNotFields ()
bool	hasParticleBlur ()
int	irisPos (LWTime time, int pass, float irisx, float irisy)
bool	isRightEye ()
bool	isStereo ()
	Returns a boolean value indicating if the camera has Stero rendering active or not.
void	maskColor (LWDVector color)
void	maskLimits (int x0, int y0, int x1, int y1) const
unsigned int	motionBlur ()
int	motionBlurPasses (LWTime time)
unsigned int	noiseSampler ()
	Returns the noiseSampler of the camera.
bool	oddFirst ()
double	overSampling (LWTime time)
double	pixelAspect (LWTime time)
void	regionLimits (int x0, int y0, int x1, int y1) const
void	resolution (int w, int h)
double	separation (LWTime time)
void	setID (LWItemID _camera)
double	shutterEfficiency (LWTime time)
bool	supportsDOF ()
bool	usePlugin ()
	Returns a boolean value indicating that the camera is using a Camera Plugin.
bool	usingGlobalBlur ()
	Returns a boolean value indicating if the camera use the Motion Blur global settings in the Render Globals panel.
bool	usingGlobalMask ()
	Returns a boolean value indicating if the camera use the Mask global settings in the Render Globals panel.
bool	usingGlobalResolution ()
	Returns a boolean value indicating if the camera use the global settings in the Render Globals panel.
const char *	whichField ()
double	zoomFactor (LWTime time)

Protected Member Functions
bool	_acquireGlobal ()
virtual bool	available () const
	Check if the global is available.
virtual LWCameraInfo *	getGlobal ()
	Get the pointer to the global.
LWCameraInfo *	operator-> ()
	Get the pointer to the global.

Static Protected Attributes
static LWCameraInfo *	globPtr
	Pointer to the global functions.

Detailed Description

Returns information about one of the existing cameras on the loaded scene

Constructor & Destructor Documentation

lwpp::CameraInfo::CameraInfo ( LWItemID _camera = LWITEM_NULL )

inline

Constructor.

Member Function Documentation

bool lwpp::GlobalBase< LWCameraInfo >::_acquireGlobal ( )

inlineprotectedinherited

unsigned int lwpp::CameraInfo::antiAliasing ( LWTime time )

inline

Returns a value indicating the Antialiasing level for the camera

Parameters:

time	Specified time

virtual bool lwpp::GlobalBase< LWCameraInfo >::available ( ) const

inlinevirtualinherited

Check if the global is available.

double lwpp::CameraInfo::blurLength ( LWTime time )

inline

Returns the blur length of the camera at an specified time If the usingGlobalMBR is true the value returned by this the one specified in the Render Globals panel

Parameters:

time	Specified time

void lwpp::CameraInfo::diaphragm	(	LWTime	time,
		int *	sides,
		double *	rotation
	)

inline

Fills the number of sides and it's rotation (in radians) of the diaphragm for the camera.

Parameters:

time	Specified time
*sides	Pointer to int where number of sides of the diaphragm would be stored.
*rotation	Pointer to double where the rotation of the diaphragm would be stored.

bool lwpp::CameraInfo::evenFirst ( )

inline

Returns a boolean value indicating if the camera has Even First Field Rendering If the usingGlobal is true the value returned by this is the one specified in the Render Globals panel

unsigned int lwpp::CameraInfo::fieldRendering ( )

inline

Returns a value indicating the type of Field Rendering the camera has If the usingGlobal is true the value returned by this is the one specified in the Render Globals panel The possible returned values are LWCAMFIELDR_OFF LWCAMFIELDR_EVENFIRST LWCAMFIELDR_ODDFIRST

void lwpp::CameraInfo::filmSize	(	double *	width,
		double *	height
	)

inline

Returns a value indicating size in meters of the Film Size for the camera If the usingGlobal is true the value returned by this is the one specified in the Render Globals panel

Parameters:

*width	Pointer to double where the horizontal film size would be stored.
*height	Pointer to double where the vertical film size would be stored.

unsigned int lwpp::CameraInfo::flags ( )

inline

Returns the flags of the camera.

double lwpp::CameraInfo::focalDistance ( LWTime time )

inline

Returns the focal distance of the camera at an specified time

Parameters:

time	Specified time

double lwpp::CameraInfo::focalLength ( LWTime time )

inline

Returns the focal length of the camera at an specified time

Parameters:

time	Specified time

void lwpp::CameraInfo::fovAngles	(	LWTime	time,
		double *	hfov,
		double *	vfov
	)

inline

Returns the Field Of View, Horizontal and Vertical angles of the camera at an specified time The values are specified in radians.

Parameters:

time	Specified time
*hfov	Pointer to double where horizontal FOV would be stored
*vfov	Pointer to double where vertical FOV would be stored

bool lwpp::CameraInfo::frameTiming	(	LWFrame	frame,
		LWFrameTimingInfo *	timingInfo
	)

inline

Returns a boolean value indicating if the structure with the timing information for the camera and a sepecified frame frame has been correctly filled. The frame value is a frame number, not a time value. Refer to the SDK docs for a complete explanation

Parameters:

frame	Frame number.
*timingInfo	Pointer to LWFrameTimingInfo struct.

double lwpp::CameraInfo::fStop ( LWTime time )

inline

Returns the fstop number of the camera at an specified time

Parameters:

time	Specified time

virtual LWCameraInfo * lwpp::GlobalBase< LWCameraInfo >::getGlobal ( )

inlinevirtualinherited

Get the pointer to the global.

LWItemID lwpp::CameraInfo::getID ( ) const

inline

Returns the LWItemID of the camera.

bool lwpp::CameraInfo::hasDOF ( )

inline

Returns a boolean value indicating if the camera has Depth of Field active.

bool lwpp::CameraInfo::hasLimitedRegion ( )

inline

Returns a boolean value indicating if the camera has a Limited Region active.

bool lwpp::CameraInfo::hasMask ( )

inline

Returns a boolean value indicating if the camera has a Mask active.

bool lwpp::CameraInfo::hasNoLRBorders ( )

inline

Returns a boolean value indicating if the camera use a Limited Region without borders.

bool lwpp::CameraInfo::hasNotFields ( )

inline

Returns a boolean value indicating if the camera DO NOT has Field Rendering If the usingGlobal is true the value returned by this is the one specified in the Render Globals panel

bool lwpp::CameraInfo::hasParticleBlur ( )

inline

Returns a boolean value indicating if the camera has Particle Blur active If the usingGlobalMBR is true the value returned by this about LWCAMF_PARTICLE_BLUR flag is the one specified in the Render Globals panel

int lwpp::CameraInfo::irisPos	(	LWTime	time,
		int	pass,
		float *	irisx,
		float *	irisy
	)

inline

Returns the iris position of the camera at an specified time and antialiasing pass? Usually this value is used on DOF and represent a sample point in the aperture of the canera. Has a range equal to: -1: lower height of aperture, 1: height of aperture The pas number can go from 0 to SceneInfo.maxSamplesPerPixel - 1. If there is a sample point, it returns 1, 0 if not exists a sample point.

Parameters:

time	Specified time
pass	Number of antialiasing pass
*irisx	Pointer to float where the x coordinate of the iris in the aperture would be stored. A value beteen -1..1
*irisy	Pointer to float where the y coordinate of the iris in the aperture would be stored. A value beteen -1..1

bool lwpp::CameraInfo::isRightEye ( )

inline

bool lwpp::CameraInfo::isStereo ( )

inline

Returns a boolean value indicating if the camera has Stero rendering active or not.

void lwpp::CameraInfo::maskColor ( LWDVector color )

inline

Returns the color of the camera mask If the camera has a Mask active must be checked with hasMask();

Parameters:

*color Pointer to LWDVector where color of the mask would be stored

void lwpp::CameraInfo::maskLimits	(	int *	x0,
		int *	y0,
		int *	x1,
		int *	y1
	)		const

inline

Returns the measure in pixels for the Mask of the camera. The extents are returned in four integer values that must be passed to it X0, Y0, X1, Y1 If the camera has a Mask active must be checked with hasMask();

Parameters:

*x0	Pointer to int where the left limit in pixels would be stored
*y0	Pointer to int where the top limit in pixels would be stored
*x1	Pointer to int where the right limit in pixels would be stored
*y1	Pointer to int where the bottom limit in pixels would be stored

unsigned int lwpp::CameraInfo::motionBlur ( )

inline

Returns a value indicating the type of MotionBlur that the camera has If the usingGlobal is true the value returned by this is the one specified in the Render Globals panel The possible returned values are LWCAMMB_OFF LWCAMMB_NORMAL LWCAMMB_DITHERED

int lwpp::CameraInfo::motionBlurPasses ( LWTime time )

inline

Returns a value indicating the number of MotionBlur passes for the camera If the usingGlobal is true the value returned by this is the one specified in the Render Globals panel

Parameters:

time	Specified time

unsigned int lwpp::CameraInfo::noiseSampler ( )

inline

Returns the noiseSampler of the camera.

bool lwpp::CameraInfo::oddFirst ( )

inline

Returns a boolean value indicating if the camera has Odd First Field Rendering If the usingGlobal is true the value returned by this is the one specified in the Render Globals panel

LWCameraInfo * lwpp::GlobalBase< LWCameraInfo >::operator-> ( )

inlineinherited

Get the pointer to the global.

double lwpp::CameraInfo::overSampling ( LWTime time )

inline

Returns a value indicating the Oversampling number for the camera

Parameters:

time	Specified time

double lwpp::CameraInfo::pixelAspect ( LWTime time )

inline

Returns the pixel aspect ratio: Image Width / Image Height at an specified time If the returned value is greater than 1.0, the pixels are short wide. If the returned value is less than 1.0, the pixels are tall thin. If the usingGlobal is true the value returned by this is the pixelAspect specified in the Render Globals panel

Parameters:

time	Specified time

void lwpp::CameraInfo::regionLimits	(	int *	x0,
		int *	y0,
		int *	x1,
		int *	y1
	)		const

inline

Returns the measure in pixels of the limits for the limited region area. The extents are returned in four integer values that must be passed to it X0, Y0, X1, Y1

Parameters:

*x0	Pointer to int where the left position in pixels would be stored
*y0	Pointer to int where the top position in pixels would be stored
*x1	Pointer to int where the right position in pixels would be stored
*y1	Pointer to int where the bottom position in pixels would be stored

void lwpp::CameraInfo::resolution	(	int *	w,
		int *	h
	)

inline

Returns the width and height resolution in pixels that the camera will use during rendering

Parameters:

*w	Pointer to int where the horizontal resolution would be stored
*h	Pointer to int where the vertical resolution would be stored

double lwpp::CameraInfo::separation ( LWTime time )

inline

Returns a double value indicating the Eye Separation If the camera has the Stereo active must be checked with isStereo();

Parameters:

time	Specified time

void lwpp::CameraInfo::setID ( LWItemID _camera )

inline

Changes the LWItemID of the camera to a new one so the class can be used with more than one camera

Parameters:

_camera ID of the new Camera to use

double lwpp::CameraInfo::shutterEfficiency ( LWTime time )

inline

Returns a value indicating the Shutter Efficiency for the camera It is expresed as a decimal value: 0 = 0%, 0.5 = 50%, 1 = 100% If the usingGlobalBlur is true the value returned by this is the one specified in the Render Globals panel

Parameters:

time	Specified time

bool lwpp::CameraInfo::supportsDOF ( )

inline

Returns a boolean value indicating if the camera supports Depth of Field If the camera has the DOF active must be checked with hasDOF();

bool lwpp::CameraInfo::usePlugin ( )

inline

Returns a boolean value indicating that the camera is using a Camera Plugin.

bool lwpp::CameraInfo::usingGlobalBlur ( )

inline

Returns a boolean value indicating if the camera use the Motion Blur global settings in the Render Globals panel.

bool lwpp::CameraInfo::usingGlobalMask ( )

inline

Returns a boolean value indicating if the camera use the Mask global settings in the Render Globals panel.

bool lwpp::CameraInfo::usingGlobalResolution ( )

inline

Returns a boolean value indicating if the camera use the global settings in the Render Globals panel.

const char* lwpp::CameraInfo::whichField ( )

inline

Returns a string indicating which fiel is beign used by the camera If the usingGlobal is true the value returned by this about LWCAMF_FIELD flag is the one specified in the Render Globals panel

double lwpp::CameraInfo::zoomFactor ( LWTime time )

inline

Returns the zoom factor of the camera at an specified time

Parameters:

time	Specified time

Member Data Documentation

LWCameraInfo * lwpp::GlobalBase< LWCameraInfo >::globPtr

staticprotectedinherited

Pointer to the global functions.

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

camerainfo.h

Public Member Functions

Protected Member Functions

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation