Python Script Engine  1.0
GL Studio Editor Python Script API
GlsLightSource Class Reference
+ Inheritance diagram for GlsLightSource:

Public Types

enum  LightType_e {
- Public Types inherited from DisplayObject
enum  MemberAccess_e {
enum  PickableType_e {
enum  PolygonClose_e {
enum  PolygonMode_e {
enum  ShadingType_e {
enum  TextureMap_e {
enum  TextureFilter_e {
enum  TessellateType_e {
enum  RotationAxis_e {
enum  LineStyle_e {
enum  AlphaMode_e {

Public Member Functions

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

Static Public Member Functions

static GlsLightSourceCastToGlsLightSource (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


Constructor & Destructor Documentation

GlsLightSource::GlsLightSource ( )

default ctor

GlsLightSource::GlsLightSource ( GlsLightSource src)

copy ctor

Member Function Documentation

static GlsLightSource* GlsLightSource::CastToGlsLightSource ( DisplayObject obj)

Casts a display object to a lightsource.

objThe display object to cast.
void GlsLightSource::ConstantAttenuation ( float  c)

Set the constant attenuation coefficient.

cNew coefficient
float GlsLightSource::ConstantAttenuation ( )

Get the constant attenuation coefficient.

The coefficient
GlsColor GlsLightSource::GetAmbient ( )

Get the ambient color for this light.

The ambient color
GlsColor GlsLightSource::GetDiffuse ( )

Get the diffuse color for this light.

The diffuse color
GlsColor GlsLightSource::GetSpecular ( )

Get the specular color for this light.

The specular color
GlsLightSource::LightType_e GlsLightSource::LightType ( void  )

Get what type of light this is.

Tye type of light (
See also
void GlsLightSource::LightType ( GlsLightSource::LightType_e  lt)

Set what type of light this is.

ltThe type of light (
See also
void GlsLightSource::LinearAttenuation ( float  c)

Set the linear attenuation coefficient.

cNew coefficient
float GlsLightSource::LinearAttenuation ( )

Get the linear attenuation coefficient.

The coefficient
void GlsLightSource::QuadraticAttenuation ( float  c)

Set the quadratic attenuation coefficient.

cNew coefficient
float GlsLightSource::QuadraticAttenuation ( )

Get the quadratic attenuation coefficient.

The coefficient
void GlsLightSource::SetAmbient ( GlsColor  color)

Set the ambient color for this light.

colorThe new ambient color
void GlsLightSource::SetDiffuse ( GlsColor  color)

Set the diffuse color for this light.

colorThe new diffuse color
void GlsLightSource::SetSpecular ( GlsColor  color)

Set the specular color for this light.

colorThe new specular color
void GlsLightSource::SpotCutoff ( float  s)

Set the spot cutoff factor.

sNew spot cutoff factor
float GlsLightSource::SpotCutoff ( )

Get the spot cutoff factor.

Spot cutoff factor
void GlsLightSource::SpotExponent ( float  s)

Set the spot exponent.

sNew spot exponent
float GlsLightSource::SpotExponent ( )

Get the spot exponent.

Spot exponent

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