CSLight Object
The CSLight Object represents a 3DCrafter Light.
| Attenuation | GetConstantAttenuation |
| SetConstantAttenuation | |
| GetLinearAttenuation | |
| SetLinearAttenuation | |
| GetQuadraticAttenuation | |
| SetQuadraticAttenuation |
| Spotlight | GetSpotlightRange |
| SetSpotlightRange | |
| GetSpotlightUmbra | |
| SetSpotlightUmbra | |
| GetSpotlightPenumbra | |
| SetSpotlightPenumbra |
| Hierarchy | GetParentGroup |
Gets the light's unique identifier.
Syntax
shape.GetID() As Variant
Gets the light type.
Syntax
shape.GetType() As Variant
Remarks
0=Ambient Light
1=Point Light
2=Spot Light
3=Directional Light
4=Area Light
Gets the light color.
Syntax
shape.GetColor(Red As Variant,
Green As Variant,
Blue As Variant)
Remarks
Each color component may be from 0 to 1 in intensity.
Sets the light color.
Syntax
shape.SetColor(Red As Variant,
Green As Variant,
Blue As Variant)
Remarks
Each color component may be from 0 to 1 in intensity.
Gets the constant attenuation for the light.
Syntax
shape.GetConstantAttenuation() As Variant
Remarks
May be from 0 to 1, but the total attenuation of the light may not exceed 1.
Sets the constant attenuation for the light.
Syntax
shape.SetConstantAttenuation(ConstantAttenuation As Variant)
Remarks
May be from 0 to 1, but the total attenuation of the light may not exceed 1.
Gets the linear attenuation for the light.
Syntax
shape.GetLinearAttenuation() As Variant
Remarks
May be from 0 to 1, but the total attenuation of the light may not exceed 1.
Sets the linear attenuation for the light.
Syntax
shape.SetLinearAttenuation(LinearAttenuation As Variant)
Remarks
May be from 0 to 1, but the total attenuation of the light may not exceed 1.
Gets the quadratic attenuation for the light.
Syntax
shape.GetQuadraticAttenuation() As Variant
Remarks
May be from 0 to 1, but the total attenuation of the light may not exceed 1.
Sets the quadratic attenuation for the light.
Syntax
shape.SetQuadraticAttenuation(QuadraticAttenuation As Variant)
Remarks
May be from 0 to 1, but the total attenuation of the light may not exceed 1.
Gets the maximum range for the spotlight.
Syntax
shape.GetSpotlightRange() As Variant
Remarks
In 3DCrafter units.
Set the maximum range for the spotlight.
Syntax
shape.SetSpotlightRange(Range As Variant)
Remarks
In 3DCrafter units.
Gets the spotlight umbra.
Syntax
shape.GetSpotlightUmbra() As Variant
Remarks
In Radians. pi Radians = 180 Degrees.
Sets the spotlight umbra.
Syntax
shape.SetSpotlightUmbra(Umbra As Variant)
Remarks
In Radians. pi Radians = 180 Degrees.
Gets the spotlight penumbra.
Syntax
shape.GetSpotlightPenumbra() As Variant
Remarks
In Radians. pi Radians = 180 Degrees.
Sets the spotlight penumbra.
Syntax
shape.SetSpotlightPenumbra(Penumbra As Variant)
Remarks
In radians. pi radians = 180 degrees.
Gets the CSGroup that is the parent group of the light.
Syntax
shape.GetParentGroup() As CSGroup