CIP C++ documentation for class "wfcLightSourceInstruction"

Class wfcLightSourceInstruction

# include <wfcDisplay.h> class wfcLightSourceInstruction : public virtual xobject { xdeclare(wfcLightSourceInstruction) ... }; This is a COMPACT class.

Description

Information related to light sources used for rendering

Manual References:: Graphics: Setting Light Sources

Method Summary


`static wfcLightSourceInstruction_ptr`	`Create (optional xrstring inName, optional wfcLightType inType, optional pfcColorRGB_ptr inColor, optional xbool inIsActive)`
	Create a light source

`optional xbool`	`GetCastShadows ()`
`void`	`SetCastShadows (optional xbool value)`
	Cast a shadow

`optional pfcColorRGB_ptr`	`GetColor ()`
`void`	`SetColor (optional pfcColorRGB_ptr value)`
	Color of the light which is same as the lightbulb. Note Valid values for each of the RGB is from 0.00 to 1.00. For all out of range values value of RGB will be set to 1.00

`optional pfcVector3D_ptr`	`GetDirection ()`
`void`	`SetDirection (optional pfcVector3D_ptr value)`
	Direction of light source with respect to model coordinate system.

`optional xbool`	`GetIsActive ()`
`void`	`SetIsActive (optional xbool value)`
	Checks if light source is active or not

`optional xstring`	`GetName ()`
`void`	`SetName (optional xrstring value)`
	Name of the light source

`optional pfcPoint3D_ptr`	`GetPosition ()`
`void`	`SetPosition (optional pfcPoint3D_ptr value)`
	Position of light source with respect to model coordinate system.

`optional xreal`	`GetSpreadAngle ()`
`void`	`SetSpreadAngle (optional xreal value)`
	Angle in degree if type is wfcLIGHT_SPOT Note Valid values for angle from 0.00 to 180.00. For all out of range values value of angle will be set to 180.00.

`optional wfcLightType`	`GetType ()`
`void`	`SetType (optional wfcLightType value)`
	Type of the light source

Method Detail

`optional xstring`	`GetName`	`()`
`void`	`SetName`	`(optional xrstring value)`

Name of the light source

Manual References:: Graphics: Setting Light Sources, Graphics: Setting Light Sources, Graphics: Setting Light Sources, Graphics: Setting Light Sources

`optional wfcLightType`	`GetType`	`()`
`void`	`SetType`	`(optional wfcLightType value)`

Type of the light source

Manual References:: Graphics: Setting Light Sources, Graphics: Setting Light Sources, Graphics: Setting Light Sources, Graphics: Setting Light Sources

`optional xbool`	`GetIsActive`	`()`
`void`	`SetIsActive`	`(optional xbool value)`

Checks if light source is active or not

Manual References:: Graphics: Setting Light Sources, Graphics: Setting Light Sources, Graphics: Setting Light Sources

`optional pfcColorRGB_ptr`	`GetColor`	`()`
`void`	`SetColor`	`(optional pfcColorRGB_ptr value)`

Color of the light which is same as the lightbulb.
Note Valid values for each of the RGB is from 0.00 to 1.00. For all out of range values value of RGB will be set to 1.00

Manual References:: Graphics: Setting Light Sources, Graphics: Setting Light Sources, Graphics: Setting Light Sources, Graphics: Setting Light Sources

`optional pfcPoint3D_ptr`	`GetPosition`	`()`
`void`	`SetPosition`	`(optional pfcPoint3D_ptr value)`

Position of light source with respect to model coordinate system.

Manual References:: Graphics: Setting Light Sources, Graphics: Setting Light Sources, Graphics: Setting Light Sources, Graphics: Setting Light Sources

`optional pfcVector3D_ptr`	`GetDirection`	`()`
`void`	`SetDirection`	`(optional pfcVector3D_ptr value)`

Direction of light source with respect to model coordinate system.

Manual References:: Graphics: Setting Light Sources, Graphics: Setting Light Sources, Graphics: Setting Light Sources, Graphics: Setting Light Sources

`optional xreal`	`GetSpreadAngle`	`()`
`void`	`SetSpreadAngle`	`(optional xreal value)`

Angle in degree if type is wfcLIGHT_SPOT
Note Valid values for angle from 0.00 to 180.00. For all out of range values value of angle will be set to 180.00.

Manual References:: Graphics: Setting Light Sources, Graphics: Setting Light Sources, Graphics: Setting Light Sources, Graphics: Setting Light Sources

`optional xbool`	`GetCastShadows`	`()`
`void`	`SetCastShadows`	`(optional xbool value)`

Cast a shadow

Manual References:: Graphics: Setting Light Sources, Graphics: Setting Light Sources, Graphics: Setting Light Sources, Graphics: Setting Light Sources

static wfcLightSourceInstruction_ptr Create (optional xrstring inName, optional wfcLightType inType, optional pfcColorRGB_ptr inColor, optional xbool inIsActive)

Create a light source

Manual References:: Graphics: Setting Light Sources, Graphics: Setting Light Sources

Parameters:

inName: Name of the light. If null default name will be set
inType: Type of the light. If null wfcLIGHT_SPOT will be set
inColor: Color of the light. If null green color will be set
inIsActive: Active status of the light. If null light will be set to be activated

Returns: