3ds Max C++ API Reference
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
LightState Struct Reference

This structure describes the properties of a light. More...

#include <object.h>

+ 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.
 
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
 

Additional Inherited Members

- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator 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.
 
static UtilExport voidoperator 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.
 
static UtilExport voidoperator 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.
 
static UtilExport voidoperator 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.
 
static UtilExport voidoperator 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.
 
static UtilExport voidoperator 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.
 
static UtilExport voidoperator new[] (size_t size)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator 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.
 
static UtilExport voidoperator 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.
 
static UtilExport voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects.
 
static UtilExport voidoperator 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.
 
static UtilExport voidoperator 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.
 
static UtilExport voidoperator 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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
static UtilExport voidoperator new (size_t size, void *placement_ptr)
 Placement new operator.
 
static UtilExport void operator delete (void *ptr, void *placement_ptr)
 Placement delete operator.
 
static UtilExport voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary.
 
static UtilExport voidaligned_realloc (void *ptr, size_t size, size_t alignment)
 Reallocates memory on a specified alignment boundary.
 
static UtilExport void aligned_free (void *ptr)
 Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.
 

Detailed Description

This structure describes the properties of a light.

See also
Class GenLight, Class LightObject, Class Color, Class Matrix3

Constructor & Destructor Documentation

◆ LightState()

LightState ( )
inline
3024 {
3025 useAtten = 0;
3026 useNearAtten = 0;
3027 attenStart = 0.0f;
3028 nearAttenStart = 0.0f;
3029 attenEnd = 0.0f;
3030 nearAttenEnd = 0.0f;
3031 extra = 0x0000;
3032 intens = 0.0f;
3033 shadow = 0;
3034 fallsize = 0.0f;
3035 on = 0;
3036 affectDiffuse = 0;
3037 ambientOnly = 0;
3038 overshoot = 0;
3039 shape = 0;
3040 type = OMNI_LGT;
3041 affectSpecular = 0;
3042 aspect = 0.0f;
3043 hotsize = 0.0f;
3044 }
@ OMNI_LGT
Definition: LightTypeEnums.h:12
BOOL affectDiffuse
TRUE if affect diffuse is on; otherwise FALSE.
Definition: object.h:3018
BOOL on
TRUE if the light is on; otherwise FALSE.
Definition: object.h:3016
LightType type
One of the following values from enum LightType: OMNI_LGT - Omnidirectional SPOT_LGT - Spot (cone) ...
Definition: object.h:2983
float intens
The multiplier applied to the color.
Definition: object.h:2989
BOOL ambientOnly
Definition: object.h:3021
BOOL overshoot
TRUE if the light supports overshoot; otherwise FALSE.
Definition: object.h:3012
BOOL shadow
TRUE if shadows are on; otherwise FALSE.
Definition: object.h:3014
float aspect
The aspect ratio of the light.
Definition: object.h:3010
float attenEnd
The (far) end attenuation value.
Definition: object.h:3005
float hotsize
The hotspot size in degrees.
Definition: object.h:2991
float fallsize
The hotspot falloff size in degrees.
Definition: object.h:2993
DWORD extra
Definition: object.h:3022
float nearAttenStart
The near attenuation start value.
Definition: object.h:2997
float nearAttenEnd
The near attenuation end value.
Definition: object.h:2999
int useNearAtten
Nonzero if near attenuation is used; otherwise zero.
Definition: object.h:2995
int shape
One of the following values: RECT_LIGHT, CIRCLE_LIGHT.
Definition: object.h:3008
int useAtten
Nonzero if (far) attenuation is used; otherwise zero.
Definition: object.h:3001
BOOL affectSpecular
TRUE if affect specular is on; otherwise FALSE.
Definition: object.h:3020
float attenStart
The (far) start attenuation value.
Definition: object.h:3003

Member Data Documentation

◆ type

LightType type

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

◆ tm

Matrix3 tm

The transformation matrix of the light.


◆ color

Color color

The color of the light (its intensity).


◆ intens

float intens

The multiplier applied to the color.


◆ hotsize

float hotsize

The hotspot size in degrees.


◆ fallsize

float fallsize

The hotspot falloff size in degrees.


◆ useNearAtten

int useNearAtten

Nonzero if near attenuation is used; otherwise zero.

◆ nearAttenStart

float nearAttenStart

The near attenuation start value.

◆ nearAttenEnd

float nearAttenEnd

The near attenuation end value.

◆ useAtten

int useAtten

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


◆ attenStart

float attenStart

The (far) start attenuation value.


◆ attenEnd

float attenEnd

The (far) end attenuation value.


◆ shape

int shape

One of the following values:
RECT_LIGHT, CIRCLE_LIGHT.

◆ aspect

float aspect

The aspect ratio of the light.


◆ overshoot

BOOL overshoot

TRUE if the light supports overshoot; otherwise FALSE.


◆ shadow

BOOL shadow

TRUE if shadows are on; otherwise FALSE.


◆ on

BOOL on

TRUE if the light is on; otherwise FALSE.


◆ affectDiffuse

BOOL affectDiffuse

TRUE if affect diffuse is on; otherwise FALSE.


◆ affectSpecular

BOOL affectSpecular

TRUE if affect specular is on; otherwise FALSE.


◆ ambientOnly

BOOL ambientOnly

◆ extra

DWORD extra