Main Page Packages Class Tree Index Help

Previous | Next

Summary: Field | Property | Contructor | Method

Detail: Field | Property | Contructor | Method

de.mirell.m3d

class CLight

Object | +--de.mirell.m3d.CLight

Implemented Interfaces: IPositionable, IXMLSerializableAll Known Subclasses: CPointLight

dynamic class CLight extends Object

Example:

Author:
Mirell Development
Version:
1.0

Constructor

public CLight ( diffuse, ambient: CColor)

Creates an ambient light

Method Summary

public fromXML ( value: XML ): Void

Unserializes XML into the object

public getAmbientColor ( ): CColor

public getDiffuseColor ( ): CColor

public getName ( ): String

public getPosition ( ): CCoordinate

Retrieves the current center point of the object

public setAmbientColor ( Value: CColor ): CLight

public setDiffuseColor ( Value: CColor ): CLight

public setName ( Value: String ): Void

public setPosition ( Value: CCoordinate ): Void

Sets the center point of the object

public toXML ( ): XML

Serializes the object into XML

public translate ( Value: CCoordinate ): Void

Translate the position of the object

Constructor Documentation

CLight

public function CLight (

diffuse,
ambient: CColor)

Creates an ambient light

Instance is positioned at 0,0,0.

Method Documentation

fromXML

public function fromXML (

value: XML): Void

Unserializes XML into the object

Object state is set according to XML.

Specified by:
fromXML in interface de.mirell.xml.serialization.IXMLSerializable
Parameters:
value
XML which represents the serialized form of the object

getAmbientColor

public function getAmbientColor (

): CColor

getDiffuseColor

public function getDiffuseColor (

): CColor

getName

public function getName (

): String

getPosition

public function getPosition (

): CCoordinate

Retrieves the current center point of the object

Specified by:
getPosition in interface IPositionable
Returns:
The center of the object

setAmbientColor

public function setAmbientColor (

Value: CColor): CLight

setDiffuseColor

public function setDiffuseColor (

Value: CColor): CLight

setName

public function setName (

Value: String): Void

setPosition

public function setPosition (

Value: CCoordinate): Void

Sets the center point of the object

Specified by:
setPosition in interface IPositionable
Parameters:
Value
The new center of the object

toXML

public function toXML (

): XML

Serializes the object into XML

The current object state will be serialized. The fromXML method must be able to unserialize the XML.

Specified by:
toXML in interface de.mirell.xml.serialization.IXMLSerializable
Returns:
The XML which contains the serialized representation of the object

translate

public function translate (

Value: CCoordinate): Void

Translate the position of the object

Specified by:
translate in interface ITranslateable
Parameters:
Value
The amount to translate the object's position's x,y and z values using a CCoordinate

The documentation was generated from the following file:

CLight.as, Last Modified: 03.09.2004 21:50:46