LightState Struct Reference

#include <object.h>

Class Description

This structure describes the properties of a light.

See also

Class GenLight, Class LightObject, Class Color, Class Matrix3

Inheritance diagram for LightState:

Public Member Functions
	LightState ()

Public Attributes
LightType	type
	One of the following values from enum LightType: OMNI_LGT - Omnidirectional SPOT_LGT - Spot (cone) DIRECT_LGT - Directional (parallel) AMBIENT_LGT - Global. More...
Matrix3	tm
	The transformation matrix of the light. More...
Color	color
	The color of the light (its intensity). More...
float	intens
	The multiplier applied to the color. More...
float	hotsize
	The hotspot size in degrees. More...
float	fallsize
	The hotspot falloff size in degrees. More...
int	useNearAtten
	Nonzero if near attenuation is used; otherwise zero. More...
float	nearAttenStart
	The near attenuation start value. More...
float	nearAttenEnd
	The near attenuation end value. More...
int	useAtten
	Nonzero if (far) attenuation is used; otherwise zero. More...
float	attenStart
	The (far) start attenuation value. More...
float	attenEnd
	The (far) end attenuation value. More...
int	shape
	One of the following values: RECT_LIGHT, CIRCLE_LIGHT. More...
float	aspect
	The aspect ratio of the light. More...
BOOL	overshoot
	TRUE if the light supports overshoot; otherwise FALSE. More...
BOOL	shadow
	TRUE if shadows are on; otherwise FALSE. More...
BOOL	on
	TRUE if the light is on; otherwise FALSE. More...
BOOL	affectDiffuse
	TRUE if affect diffuse is on; otherwise FALSE. More...
BOOL	affectSpecular
	TRUE if affect specular is on; otherwise FALSE. More...
BOOL	ambientOnly
DWORD	extra

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Constructor & Destructor Documentation

LightState ( )

inline

                {
        useAtten = 0;
        useNearAtten = 0;
        attenStart = 0.0f;
        nearAttenStart = 0.0f;
        attenEnd = 0.0f;
        nearAttenEnd = 0.0f;
        extra = 0x0000;
        intens = 0.0f;
        shadow = 0;
        fallsize = 0.0f;
        on = 0;
        affectDiffuse = 0;
        ambientOnly = 0;
        overshoot = 0;
        shape = 0;
        type = OMNI_LGT;
        affectSpecular = 0;
        aspect = 0.0f;
        hotsize = 0.0f;
    }

Member Data Documentation

LightType type

One of the following values from enum LightType:
OMNI_LGT - Omnidirectional
SPOT_LGT - Spot (cone)
DIRECT_LGT - Directional (parallel)
AMBIENT_LGT - Global.

Matrix3 tm

The transformation matrix of the light.

Color color

The color of the light (its intensity).

float intens

The multiplier applied to the color.

float hotsize

The hotspot size in degrees.

float fallsize

The hotspot falloff size in degrees.

int useNearAtten

Nonzero if near attenuation is used; otherwise zero.

float nearAttenStart

The near attenuation start value.

float nearAttenEnd

The near attenuation end value.

int useAtten

Nonzero if (far) attenuation is used; otherwise zero.

float attenStart

The (far) start attenuation value.

float attenEnd

The (far) end attenuation value.

int shape

One of the following values:
RECT_LIGHT, CIRCLE_LIGHT.

float aspect

The aspect ratio of the light.

BOOL overshoot

TRUE if the light supports overshoot; otherwise FALSE.

BOOL shadow

TRUE if shadows are on; otherwise FALSE.

BOOL on

TRUE if the light is on; otherwise FALSE.

BOOL affectDiffuse

TRUE if affect diffuse is on; otherwise FALSE.

BOOL affectSpecular

TRUE if affect specular is on; otherwise FALSE.

BOOL ambientOnly

DWORD extra