Class CM3Light
CM3Light Class
Container class for a 3D light object. Allows the light to be moved by the user if desired.
This class implements the Ambient light features and the ability to move a control object
around. While Ambient lights do not have a control object, most of the subclasses of this
class do.
CM3Light - base light with most functions lights need (this is most like the PointLight)
CM3LightAmbient - ambient light which just has a color and intensity with no other parameters
CM3LightSpot - adds to CM3Light...
CM3LightPoint - adds to CM3Light: position, distance, decay, and shadows
CM3LightDirectional adds to CM3Light: shadows, target (direction is from position to target)
CM3LightHemisphere - adds to CM3Light: skycolor, gorundColor, shadows
- adds a number of settings
Settings Group: Position
| Setting |
Name |
Type |
Options |
Default |
Comments |
| Translations |
Position Offset Vector |
CMTYPE_VECTOR |
|
null,Initial:[1,1,1] |
x,y, and z values to offset the item |
| Scales |
Scaling Vector |
CMTYPE_VECTOR |
|
null,Initial:[1,1,1] |
x,y, and z scaling values for the item's size |
Settings Group: Shadows
| Setting |
Name |
Type |
Options |
Default |
Comments |
| cast |
Cast Shadows |
CMTYPE_BOOLEAN |
|
false |
must be set before the OGL object is created (or recreate on set) |
| receive |
Receive Shadow |
CMTYPE_BOOLEAN |
|
false |
must be set before the OGL object is created (or recreate on set) |
Settings Group: Light
| Setting |
Name |
Type |
Options |
Default |
Comments |
| Intensity |
Intensity |
CMTYPE_FLOAT |
|
1 |
0 to 1 |
| On |
On |
CMTYPE_BOOLEAN |
|
true |
|
| AddHelper |
Add Helper |
CMTYPE_BOOLEAN |
|
false |
|
Settings Group: ControlObject
| Setting |
Name |
Type |
Options |
Default |
Comments |
| Radius |
Radius |
CMTYPE_FLOAT |
|
100 |
|
| Name |
Name |
CMTYPE_STRING |
|
|
Name that appears in the item and layer lists |
| Open |
Open |
CMTYPE_BOOLEAN |
|
false |
true if the object is open in the editor tree |
| Status |
Status |
CMTYPE_INDEXES |
CMSTATUS_OPTIONS, Default:CMSTATUS_SELECTABLE |
CMSTATUS_SELECTABLE |
How the item appears to the user and how the user can interact with it |
| ElevationAngle |
Elevation Angle |
CMTYPE_FLOAT |
|
0 |
|
| BearingAngle |
Bearing Angle |
CMTYPE_FLOAT |
|
0 |
|
| Color |
Color |
CMTYPE_COLOR |
|
rgb(128,128,128) |
must be set before the OGL object is created (or recreate on set) |
| opacity |
opacity |
CMTYPE_FLOAT |
|
1 |
must be set before the OGL object is created (or recreate on set |