Provides information about the currently loaded scene. More...

#include <sceneinfo.h>

Inheritance diagram for lwpp::SceneInfo:

Collaboration diagram for lwpp::SceneInfo:

Public Types
enum	FilterTypes { CLASSIC, BOX, BOX_SHARP, BOX_SOFT, GAUSSIAN, GAUSSIAN_SHARP, GAUSSIAN_SOFT, MITCHELL, MITCHELL_SHARP, MITCHELL_SOFT, LANCZOS, LANCZOS_SHARP, LANCZOS_SOFT, UNKNOWN }

Public Member Functions
	SceneInfo ()
	Constructor.
bool	adaptiveSampling (void) const
float	adaptiveThreshold (void) const
	Returns the adaptive sampling threshold, only valid if adaptive sampling is activated.
const char *	alphaPrefix () const
	Returns the actual Alpha prefix (i.e: tga, jpg,etc...) for the saved alpha file.
const char *	animFilename () const
	Returns the name of the current animation file.
int	antialiasing () const
bool	enhancedAA () const
	Returns a boolean value indicating if Enhanced Antialiasing is active or not.
const char *	filename () const
	Returns the name of the file scene.
LWFrame	frameEnd () const
	Returns the render end frame of the scene. This is not the same end frame as for the previews.
int	frameHeight () const
	Returns the height of the image to render in pixels.
double	framesPerSecond () const
	Returns the playback speed of the scene in frames / second.
LWFrame	frameStart () const
	Returns the render start frame of the scene. This is not the same start frame as for the previews.
LWFrame	frameStep () const
	Returns the size of the render step frame of the scene. This is not the same end frame as for the previews.
int	frameWidth () const
	Returns the width of the image to render in pixels.
const char *	getAAName () const
	Returns a boolean value indicating if Adaptive Sampling is active or not.
bool	isValid () const
	Check if we have access to the global.
int *	limitedRegion () const
int	maxSamplesPerPixel () const
int	minSamplesPerPixel () const
const char *	name () const
	Returns the loaded scene name.
int	numPoints () const
	Returns the total number of points in the scene.
int	numPolygons () const
	Returns the total number of polygons in the scene.
int	numThreads () const
	Returns the number of threads used during the rendering.
double	pixelAspect () const
FilterTypes	reconstructionFilter () const
	Returns an integer value indicating the reconstruction filter selected for the current render camera.
const char *	reconstructionFilterName () const
	Returns a string indicating the reconstruction filter selected for the current render camera.
int	recursionDepth () const
	Returns maximum recursion depth for raytracing.
LWItemID	renderCamera (LWTime time) const
LWItemID	renderCamera ()
int	renderOpts () const
int	renderType () const
	Returns the render type selected for the scene: LWRTYPE_WIRE, LWRTYPE_QUICK, LWRTYPE_REALISTIC.
const char *	RGBPrefix () const
	Returns the actual RGB prefix (i.e: tga, jpg,etc...) for the saved image file.
bool	softfilter (void) const
	Returns a boolean value indicating if Soft Filter is active or not.

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

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

Detailed Description

Provides information about the currently loaded scene.

Member Enumeration Documentation

enum lwpp::SceneInfo::FilterTypes

Enumerator:

CLASSIC
BOX
BOX_SHARP
BOX_SOFT
GAUSSIAN
GAUSSIAN_SHARP
GAUSSIAN_SOFT
MITCHELL
MITCHELL_SHARP
MITCHELL_SOFT
LANCZOS
LANCZOS_SHARP
LANCZOS_SOFT
UNKNOWN

Constructor & Destructor Documentation

lwpp::SceneInfo::SceneInfo ( )

inline

Constructor.

Member Function Documentation

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

inlineprotectedinherited

bool lwpp::SceneInfo::adaptiveSampling ( void ) const

inline

float lwpp::SceneInfo::adaptiveThreshold ( void ) const

inline

Returns the adaptive sampling threshold, only valid if adaptive sampling is activated.

const char* lwpp::SceneInfo::alphaPrefix ( ) const

inline

Returns the actual Alpha prefix (i.e: tga, jpg,etc...) for the saved alpha file.

const char* lwpp::SceneInfo::animFilename ( ) const

inline

Returns the name of the current animation file.

int lwpp::SceneInfo::antialiasing ( ) const

inline

antialiasing - Returns the actual level of antialiasing for the render camera A value of cero means antialiasing is OFF A value of 1 (lowest) to 4 (extreme) indicate the increasing antialiasing settings A value of 100 to 114. Use PLD 1 = 100, PLD 2 = 101, PLD 3 = 102, ... and PLD 15 = 114)

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

inlinevirtualinherited

Check if the global is available.

bool lwpp::SceneInfo::enhancedAA ( ) const

inline

Returns a boolean value indicating if Enhanced Antialiasing is active or not.

const char* lwpp::SceneInfo::filename ( ) const

inline

Returns the name of the file scene.

LWFrame lwpp::SceneInfo::frameEnd ( ) const

inline

Returns the render end frame of the scene. This is not the same end frame as for the previews.

int lwpp::SceneInfo::frameHeight ( ) const

inline

Returns the height of the image to render in pixels.

double lwpp::SceneInfo::framesPerSecond ( ) const

inline

Returns the playback speed of the scene in frames / second.

LWFrame lwpp::SceneInfo::frameStart ( ) const

inline

Returns the render start frame of the scene. This is not the same start frame as for the previews.

LWFrame lwpp::SceneInfo::frameStep ( ) const

inline

Returns the size of the render step frame of the scene. This is not the same end frame as for the previews.

int lwpp::SceneInfo::frameWidth ( ) const

inline

Returns the width of the image to render in pixels.

const char* lwpp::SceneInfo::getAAName ( ) const

inline

Returns a boolean value indicating if Adaptive Sampling is active or not.

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

inlinevirtualinherited

Get the pointer to the global.

bool lwpp::SceneInfo::isValid ( void ) const

inline

Check if we have access to the global.

int* lwpp::SceneInfo::limitedRegion ( ) const

inline

Returns the measure in pixels of the limited region area. The extents are returned as a pointer to a array where limreg[0] = X0, limreg[1] = Y0, limreg[2] = X1, limreg[3] = Y1

int lwpp::SceneInfo::maxSamplesPerPixel ( ) const

inline

Returns the limit for the maximum number of samples per pixel This can not be exactly computed due to the different render techniques, antialiasing modes and adaptive sampling. But this gives a range based on the current render options.

int lwpp::SceneInfo::minSamplesPerPixel ( ) const

inline

Returns the limit for the minimum number of samples per pixel This can not be exactly computed due to the different render techniques, antialiasing modes and adaptive sampling. But this gives a range based on the current render options.

const char* lwpp::SceneInfo::name ( ) const

inline

Returns the loaded scene name.

int lwpp::SceneInfo::numPoints ( ) const

inline

Returns the total number of points in the scene.

int lwpp::SceneInfo::numPolygons ( ) const

inline

Returns the total number of polygons in the scene.

int lwpp::SceneInfo::numThreads ( ) const

inline

Returns the number of threads used during the rendering.

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

inlineinherited

Get the pointer to the global.

double lwpp::SceneInfo::pixelAspect ( ) const

inline

Returns the pixel aspect ratio: Image Width / Image Height. 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.

FilterTypes lwpp::SceneInfo::reconstructionFilter ( ) const

inline

Returns an integer value indicating the reconstruction filter selected for the current render camera.

Example: lwpp::SceneInfo si; if (si.reconstructionFilter == SceneInfo::CLASSIC) {... };

const char* lwpp::SceneInfo::reconstructionFilterName ( ) const

inline

Returns a string indicating the reconstruction filter selected for the current render camera.

int lwpp::SceneInfo::recursionDepth ( ) const

inline

Returns maximum recursion depth for raytracing.

LWItemID lwpp::SceneInfo::renderCamera ( LWTime time ) const

inline

renderCamera(LWTime time) - Returns the render camera ID in the scene that will render the frame at the time specified

LWItemID lwpp::SceneInfo::renderCamera ( )

inline

renderCamera - Returns the actual render camera ID at the current scene time

int lwpp::SceneInfo::renderOpts ( ) const

inline

Returns the render options activated for the scene as flags:

LWROPT_SHADOWTRACE
LWROPT_REFLECTTRACE
LWROPT_REFRACTTRACE
LWROPT_FIELDS
LWROPT_EVENFIELDS
LWROPT_MOTIONBLUR
LWROPT_DEPTHOFFIELD
LWROPT_LIMITEDREGION
LWROPT_PARTICLEBLUR
LWROPT_ENHANCEDAA
LWROPT_SAVEANIM
LWROPT_SAVERGB
LWROPT_SAVEALPHA

LWROPT_EVENFIELDS is only ON if Field Rendering is on, and the first line of the output image is from the field that comes first in time.

int lwpp::SceneInfo::renderType ( ) const

inline

Returns the render type selected for the scene: LWRTYPE_WIRE, LWRTYPE_QUICK, LWRTYPE_REALISTIC.

const char* lwpp::SceneInfo::RGBPrefix ( ) const

inline

Returns the actual RGB prefix (i.e: tga, jpg,etc...) for the saved image file.

bool lwpp::SceneInfo::softfilter ( void ) const

inline

Returns a boolean value indicating if Soft Filter is active or not.

Member Data Documentation

LWSceneInfo * lwpp::GlobalBase< LWSceneInfo >::globPtr

staticprotectedinherited

Pointer to the global functions.

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

Public Types

Public Member Functions

Protected Member Functions

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation