GlsLightSource Class Reference

Inheritance diagram for GlsLightSource:

Public Types
enum	LightType_e {   LIGHT_LOCAL ,   LIGHT_INFINITE }
Public Types inherited from DisplayObject
enum	MemberAccess_e {   PUBLIC ,   PRIVATE ,   PROTECTED }
enum	PickableType_e {   UNPICKABLE ,   FIRST_PICK ,   BEST_PICK ,   ALWAYS_PICK }
enum	PolygonClose_e {   POLY_OPEN ,   POLY_CLOSED }
enum	PolygonMode_e {   POLY_MODE_UNDEFINED ,   POLY_MODE_POINTS ,   POLY_MODE_OUTLINE ,   POLY_MODE_FILLED ,   POLY_MODE_FILL_AND_OUTLINE }
enum	ShadingType_e {   SHADING_FLAT ,   SHADING_GOURAUD }
enum	TextureMap_e {   TEXTURE_MAP_MODULATE ,   TEXTURE_MAP_DECAL ,   TEXTURE_MAP_BLEND ,   TEXTURE_MAP_REPLACE }
enum	TextureFilter_e {   TEXTURE_FILTER_NEAREST ,   TEXTURE_FILTER_LINEAR ,   TEXTURE_FILTER_NEAREST_MIPMAP_NEAREST ,   TEXTURE_FILTER_LINEAR_MIPMAP_LINEAR ,   TEXTURE_FILTER_NEAREST_MIPMAP_LINEAR ,   TEXTURE_FILTER_LINEAR_MIPMAP_NEAREST }
enum	TessellateType_e {   TESSELLATE_UNION ,   TESSELLATE_INTERSECT ,   TESSELLATE_DIFFERENCE }
enum	RotationAxis_e {   X_AXIS ,   Y_AXIS ,   Z_AXIS }
enum	LineStyle_e {   SOLID_LINE_STYLE ,   SMALL_DOTTED_LINE_STYLE ,   DOTTED_LINE_STYLE ,   DASHED_LINE_STYLE ,   DOT_DASHED_LINE_STYLE ,   SMALL_DASHED_LINE_STYLE }
enum	AlphaMode_e {   ALPHA_MODE_UNDEFINED ,   ALPHA_MODE_OPAQUE ,   ALPHA_MODE_2_LEVEL ,   ALPHA_MODE_256_LEVEL }

Public Member Functions
	GlsLightSource ()
	GlsLightSource (GlsLightSource &src)
None	SetAmbient (GlsColor color)
None	SetDiffuse (GlsColor color)
None	SetSpecular (GlsColor color)
GlsColor	GetAmbient ()
GlsColor	GetDiffuse ()
GlsColor	GetSpecular ()
GlsLightSource::LightType_e	LightType (None)
None	LightType (GlsLightSource::LightType_e lt)
None	SpotCutoff (float s)
float	SpotCutoff ()
None	SpotExponent (float s)
float	SpotExponent ()
None	ConstantAttenuation (float c)
float	ConstantAttenuation ()
None	LinearAttenuation (float c)
float	LinearAttenuation ()
None	QuadraticAttenuation (float c)
float	QuadraticAttenuation ()
Public Member Functions inherited from DisplayObject
bool	isNULL ()
str	GetName ()
str	SetName (str name)
None	SetProtectionMode (DisplayObject::MemberAccess_e mode)
DisplayObject::MemberAccess_e	GetProtectionMode (None)
None	SetLocked (bool val)
bool	GetLocked (None)
bool	GetGenerateMemberVariable ()
None	SetGenerateMemberVariable (bool b)
bool	GetAntiAliasing ()
None	SetAntiAliasing (bool antiAliasing)
bool	GetBlinking ()
None	SetBlinking (bool blinking)
float	GetBlinkRate ()
None	SetBlinkRate (float rate)
int	GetAlphaMode ()
None	SetAlphaMode (int mode)
bool	GetCullBackFaces ()
None	SetCullBackFaces (bool cullFaces)
bool	GetZBufferTestedFlag ()
None	SetZBufferTestedFlag (bool tested)
bool	GetAffectZBufferFlag ()
None	SetAffectZBufferFlag (bool affect)
bool	GetLightingEnabledFlag ()
None	SetLightingEnabledFlag (bool enabled)
DisplayObject::PickableType_e	GetPickMode ()
None	SetPickMode (DisplayObject::PickableType_e mode)
bool	GetVisibilityFlag ()
None	SetVisibilityFlag (bool visible)
PolygonClose_e	GetClosePolygonFlag ()
None	SetClosePolygonFlag (PolygonClose_e closePolygon)
PolygonMode_e	GetPolygonMode ()
None	SetPolygonMode (PolygonMode_e polygonMode)
ShadingType_e	GetShadingMode ()
None	SetShadingMode (ShadingType_e shadingMode)
Vertex	GetLocation ()
None	SetLocation (Vertex loc)
Vertex	GetRotationPoint ()
None	SetRotationPoint (Vertex rotPoint)
GlsMatrixAffine *	GetDcsMatrix ()
None	SetDcsMatrix (GlsMatrixAffine *matrix)
int	GetMaterialIndex ()
None	SetMaterialIndex (int matIndex)
str	GetObjectClassName ()
int	GetTextureIndex ()
None	SetTextureIndex (int texIndex)
TextureMap_e	GetTextureMappingTechnique ()
None	SetTextureMappingTechnique (TextureMap_e mappingTechnique)
bool	GetTextureRepeat ()
None	SetTextureRepeat (bool repeat)
disti::GlsColor	GetBlendingColor ()
None	SetBlendingColor (GlsColor blendColor)
DisplayObject::TextureFilter_e	GetTextureMagnificationFilter ()
None	SetTextureMagnificationFilter (DisplayObject::TextureFilter_e filter)
DisplayObject::TextureFilter_e	GetTextureMinificationFilter ()
None	SetTextureMinificationFilter (DisplayObject::TextureFilter_e filter)
list	GetTextureCoordinates ()
None	SetTextureCoordinates (list &texVerts)
None	GetTextureCoordinates (VertexArray *texVerts)
None	SetTextureCoordinates (VertexArray &texVerts)
None	GetTexturePoints (VertexArray *texVerts)
None	SetTexturePoints (VertexArray &texVerts)
None	SetTexturePoints (list &texVerts)
list	GetTexturePoints ()
None	GetVertices (VertexArray *verts)
None	SetVertices (VertexArray &verts)
str	GetInitialization ()
None	SetInitialization (str initCode)
str	GetCallbackCode ()
None	SetCallbackCode (str cbCode)
DisplayObject *	DuplicateObject (Document *doc=NULL)
DisplayObject *	TessellateObject ()
DisplayObject *	ExtrudeObject (float amount)
None	RotateObject (float amount, RotationAxis_e axis)
None	TranslateObject (float x, float y, float z)
None	ScaleObject (float x, float y, float z, Vertex *anchor=NULL)
None	LineWidth (float width)
float	LineWidth ()
LineStyle_e	LineStyle ()
None	LineStyle (LineStyle_e style)
GlsColor	LineColor ()
None	LineColor (GlsColor color)
GlsColor	FillColor ()
None	FillColor (GlsColor color)
None	GetExtents (Vector &min, Vector &max)
bool	HasUserDefinedAttribute (str attribName)
std::map< str, str >	GetUserDefinedAttributes ()
UserDefinedValueAttributeList	GetAllUserDefinedAttributes ()
str	GetUserDefinedAttributeValue (str attribName)
	typemap (check) str attribName
None	SetUserDefinedAttributeValue (str attribName, str value)
DisplayObject *	GetParent ()
Document *	GetDocument ()
str	AlternateClassName ()
None	AlternateClassName (str name)
str	GetAlternateClassHeaderFile ()
None	SetAlternateClassHeaderFile (str name)
str	GetResources ()
str	GetRuntimeResources (bool recursive)
str	GetAttributeType (str attribName)
str	GetAttributeValuestr (str attribName)
None	SetAttributeValuestr (str attribName, str value)
int	RegisterObserver (str attribName, PyObject *pyfunc)
None	UnregisterObserver (str attribName, int id)
list	GetNormals ()
None	SetNormals (list &normals)
list	GetExtraAttributes ()
DisplayObject *	CloneObject ()
None	CopyProperties (DisplayObject *sourceObj)
None	SetLocation (Vector loc)
GlsMatrixAffine	GetObjectCoordinatesTransform (DisplayObject *targetObject)
None	CalculateParentBoundingBox ()
None	SetOrigin (Vertex &vert)

Static Public Member Functions
static GlsLightSource *	CastToGlsLightSource (DisplayObject *obj)

Additional Inherited Members
Static Public Attributes inherited from DisplayObject
static int	TEXTURE_INDEX_NONE = -1

Detailed Description

common editor interface variable

Member Enumeration Documentation

LightType_e

enum GlsLightSource::LightType_e

Enumerator
LIGHT_LOCAL
LIGHT_INFINITE

Constructor & Destructor Documentation

GlsLightSource() [1/2]

GlsLightSource::GlsLightSource

(

)

default ctor

GlsLightSource() [2/2]

GlsLightSource::GlsLightSource

(

GlsLightSource &

src

)

copy ctor

Member Function Documentation

CastToGlsLightSource()

static GlsLightSource * GlsLightSource::CastToGlsLightSource ( DisplayObject *  obj )

static

Casts a display object to a lightsource.

Parameters

obj	The display object to cast.

ConstantAttenuation() [1/2]

float GlsLightSource::ConstantAttenuation

(

)

Get the ant attenuation coefficient.

Returns

The coefficient

ConstantAttenuation() [2/2]

None GlsLightSource::ConstantAttenuation

(

float

c

)

Set the ant attenuation coefficient.

Parameters

c	New coefficient

GetAmbient()

GlsColor GlsLightSource::GetAmbient

(

)

Get the ambient color for this light.

Returns

The ambient color

GetDiffuse()

GlsColor GlsLightSource::GetDiffuse

(

)

Get the diffuse color for this light.

Returns

The diffuse color

GetSpecular()

GlsColor GlsLightSource::GetSpecular

(

)

Get the specular color for this light.

Returns

The specular color

LightType() [1/2]

None GlsLightSource::LightType

(

GlsLightSource::LightType_e

lt

)

Set what type of light this is.

Parameters

lt	The type of light (

See also

GlsLightSource::LightType_e)

LightType() [2/2]

GlsLightSource::LightType_e GlsLightSource::LightType

(

None

)

Get what type of light this is.

Returns

Tye type of light (

See also

GlsLightSource::LightType_e)

LinearAttenuation() [1/2]

float GlsLightSource::LinearAttenuation

(

)

Get the linear attenuation coefficient.

Returns

The coefficient

LinearAttenuation() [2/2]

None GlsLightSource::LinearAttenuation

(

float

c

)

Set the linear attenuation coefficient.

Parameters

c	New coefficient

QuadraticAttenuation() [1/2]

float GlsLightSource::QuadraticAttenuation

(

)

Get the quadratic attenuation coefficient.

Returns

The coefficient

QuadraticAttenuation() [2/2]

None GlsLightSource::QuadraticAttenuation

(

float

c

)

Set the quadratic attenuation coefficient.

Parameters

c	New coefficient

SetAmbient()

None GlsLightSource::SetAmbient

(

GlsColor

color

)

Set the ambient color for this light.

Parameters

color

The new ambient color

SetDiffuse()

None GlsLightSource::SetDiffuse

(

GlsColor

color

)

Set the diffuse color for this light.

Parameters

color

The new diffuse color

SetSpecular()

None GlsLightSource::SetSpecular

(

GlsColor

color

)

Set the specular color for this light.

Parameters

color

The new specular color

SpotCutoff() [1/2]

float GlsLightSource::SpotCutoff

(

)

Get the spot cutoff factor.

Returns

Spot cutoff factor

SpotCutoff() [2/2]

None GlsLightSource::SpotCutoff

(

float

s

)

Set the spot cutoff factor.

Parameters

s	New spot cutoff factor

SpotExponent() [1/2]

float GlsLightSource::SpotExponent

(

)

Get the spot exponent.

Returns

Spot exponent

SpotExponent() [2/2]

None GlsLightSource::SpotExponent

(

float

s

)

Set the spot exponent.

Parameters

s	New spot exponent

---

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

• GlsLightSource.i