User Tools

Site Tools


DzSpotLight

Constructors

DAZ Script
DzSpotLight ()

Methods

Detailed Description

TODO: Add detailed description.

Constructors


DzSpotLight()

Default Constructor. Creates a new spotlight.

Methods


Number : getBaseOpacity()

Return Value:

  • The (scaled) base opacity.

Since:

  • 4.9.3.145

DzFloatProperty : getBaseOpacityControl()

Return Value:

  • The property that controls the base opacity.

Since:

  • 4.9.3.145

Number : getBeamDistribution()

Return Value:

  • The beam distribution.

Since:

  • 4.9.3.145

DzFloatProperty : getBeamDistributionControl()

Return Value:

  • The property that controls beam distribution.

Number : getDecay()

Return Value:

  • The decay of the light.

Since:

  • 4.9.3.145

DzFloatProperty : getDecayControl()

Return Value:

  • The property used to control decay.

Boolean : getDisplayPersistence()

Return Value:

  • true if the cone will be displayed when the node is not selected, otherwise false.

Since:

  • 4.9.3.145

DzBoolProperty : getDisplayPersistenceControl()

Return Value:

  • The property that controls the display persistence.

Since:

  • 4.9.3.145

Number : getEdgeOpacity()

Return Value:

  • The (scaled) edge opacity.

Since:

  • 4.9.3.145

DzFloatProperty : getEdgeOpacityControl()

Return Value:

  • The property that controls the edge opacity.

Since:

  • 4.9.3.145

Number : getFalloffDistance( Number lightPercent )

TODO: Add description.


Number : getLightExponent()

Return Value:

  • The exponent (rate of decay from center to edge) of the light.

Since:

  • 4.8.0.18

DzFloatProperty : getLightExponentControl()

Return Value:

  • The property that controls the beam exponent of the light.

Since:

  • 4.8.0.18

Boolean : getLightVisibility()

TODO: Add description.


Number : getLineOpacity()

TODO: Add description.


Number : getOpacityScale()

Return Value:

  • The opacity scale.

Since:

  • 4.9.3.145

DzFloatProperty : getOpacityScaleControl()

Return Value:

  • The property that controls the opacity scale.

Since:

  • 4.9.3.145

Number : getRayLength()

Return Value:

  • The ray length.

Since:

  • 4.9.3.145

DzFloatProperty : getRayLengthControl()

Return Value:

  • The property that controls the ray length.

Since:

  • 4.9.3.145

Number : getRayOpacity()

Return Value:

  • The (scaled) ray opacity.

Since:

  • 4.9.3.145

DzFloatProperty : getRayOpacityControl()

Return Value:

  • The property that controls the ray opacity.

Since:

  • 4.9.3.145

Boolean : getShowBase()

Return Value:

  • true if the base should be shown, otherwise false.

Since:

  • 4.9.3.145

DzBoolProperty : getShowBaseControl()

Return Value:

  • The property that controls whether or not to show the base control.

Since:

  • 4.9.3.145

Boolean : getShowEdge()

Return Value:

  • true if the edge should be shown, otherwise false.

Since:

  • 4.9.3.145

DzBoolProperty : getShowEdgeControl()

Return Value:

  • The property that controls whether or not to show the edge control.

Since:

  • 4.9.3.145

Number : getSpreadAngle()

Return Value:

  • The spread angle of the light.

Since:

  • 4.9.3.145

DzFloatProperty : getSpreadAngleControl()

Return Value:

  • The property that controls the outer spread angle of the light.

void : setBaseOpacity( Number opacity )

Sets the base opacity.

Parameter(s):

  • opacity - The opacity to set.

Since:

  • 4.9.3.145

void : setBeamDistribution( Number distribution )

Sets beam distribution.

Parameter(s):

  • distribution - The beam distribution to set.

Since:

  • 4.9.3.145

void : setDecay( Number decay )

Sets the amount of decay.

Parameter(s):

  • decay - The decay to set.

Since:

  • 4.9.3.145

void : setDisplayPersistence( Boolean persistence )

Sets the persistance of the display cone.

Parameter(s):

  • persistence - If true, the cone will be displayed when the node is not selected. If false, the cone will not be displayed when the node is not selected.

Since:

  • 4.9.3.145

void : setEdgeOpacity( Number opacity )

Sets the edge opacity.

Parameter(s):

  • opacity - The opacity to set.

Since:

  • 4.9.3.145

void : setLightExponent( Number exponent )

Sets the exponent (rate of decay from center to edge) of the light.

Parameter(s):

  • exponent - The exponent to set.

Since:

  • 4.9.3.145

void : setOpacityScale( Number scale )

Sets the opacity scale.

Parameter(s):

  • scale - The scale to set.

Since:

  • 4.9.3.145

void : setRayLength( Number length )

Sets the ray length.

Parameter(s):

  • length - The length to set.

Since:

  • 4.9.3.145

void : setRayOpacity( Number opacity )

Sets the ray opacity.

Parameter(s):

  • opacity - The opacity to set.

Since:

  • 4.9.3.145

void : setShowBase( Boolean yesNo )

Sets whether or not to show the base.

Parameter(s):

  • yesNo - If true, the base will be shown.

Since:

  • 4.9.3.145

void : setShowEdge( Boolean yesNo )

Sets whether or not to show the edge.

Parameter(s):

  • yesNo - If true, the edge will be shown.

Since:

  • 4.9.3.145

void : setSpreadAngle( Number spreadAngle )

Sets the spread angle.

Parameter(s):

  • spreadAngle - The angle to set.

Since:

  • 4.9.3.145