CanvasLight Object

The CanvasLight object represents a 3D Canvas Light.

General GetID
Color GetColor
  SetColor
Attenuation GetConstantAttenuation
  SetConstantAttenuation
  GetLinearAttenuation
  SetLinearAttenuation
  GetQuadraticAttenuation
  SetQuadraticAttenuation
Spotlight GetSpotlightRange
  SetSpotlightRange
  GetSpotlightUmbra
  SetSpotlightUmbra
  GetSpotlightPenumbra
  SetSpotlightPenumbra

 

GetID

Gets the light's unique identifier.

Syntax

object.GetID() As Variant

GetColor

Gets the light color.

Syntax

object.GetColor(Red As Variant,
Green As Variant,
Blue As Variant)

Remarks

Each color component may be from 0 to 1 in intensity.

SetColor

Sets the light color.

Syntax

object.SetColor(Red As Variant,
Green As Variant,
Blue As Variant)

Remarks

Each color component may be from 0 to 1 in intensity.

GetConstantAttenuation

Gets the constant attenuation for the light.

Syntax

object.GetConstantAttenuation() As Variant

Remarks

May be from 0 to 1, but the total attenuation of the light may not exceed 1.

SetConstantAttenuation

Sets the constant attenuation for the light.

Syntax

object.SetConstantAttenuation(ConstantAttenuation As Variant)

Remarks

May be from 0 to 1, but the total attenuation of the light may not exceed 1.

GetLinearAttenuation

Gets the linear attenuation for the light.

Syntax

object.GetLinearAttenuation() As Variant

Remarks

May be from 0 to 1, but the total attenuation of the light may not exceed 1.

SetLinearAttenuation

Sets the linear attenuation for the light.

Syntax

object.SetLinearAttenuation(LinearAttenuation As Variant)

Remarks

May be from 0 to 1, but the total attenuation of the light may not exceed 1.

GetQuadraticAttenuation

Gets the quadratic attenuation for the light.

Syntax

object.GetQuadraticAttenuation() As Variant

Remarks

May be from 0 to 1, but the total attenuation of the light may not exceed 1.

SetQuadraticAttenuation

Sets the quadratic attenuation for the light.

Syntax

object.SetQuadraticAttenuation(QuadraticAttenuation As Variant)

Remarks

May be from 0 to 1, but the total attenuation of the light may not exceed 1.

GetSpotlightRange

Gets the maximum range for the spotlight.

Syntax

object.GetSpotlightRange() As Variant

Remarks

In 3D Canvas units.

SetSpotlightRange

Set the maximum range for the spotlight.

Syntax

object.SetSpotlightRange(Range As Variant)

Remarks

In 3D Canvas units.

GetSpotlightUmbra

Gets the spotlight umbra.

Syntax

object.GetSpotlightUmbra() As Variant

Remarks

In Radians. pi Radians = 180 Degrees.

SetSpotlightUmbra

Sets the spotlight umbra.

Syntax

object.SetSpotlightUmbra(Umbra As Variant)

Remarks

In Radians. pi Radians = 180 Degrees.

GetSpotlightPenumbra

Gets the spotlight penumbra.

Syntax

object.GetSpotlightPenumbra() As Variant

Remarks

In Radians. pi Radians = 180 Degrees.

SetSpotlightPenumbra

Sets the spotlight penumbra.

Syntax

object.SetSpotlightPenumbra(Penumbra As Variant)

Remarks

In radians. pi radians = 180 degrees.