Library | Package Java Toolkit

Interface LightSourceInstruction

package com.ptc.wfc.wfcDisplay;

public interface LightSourceInstruction
  extends jxobject



Description

Information related to light sources used for rendering



Method Summary
/*optional*/ BooleanGetCastShadows ()
    Get method for attribute "CastShadows"
     Cast a shadow
/*optional*/ ColorRGBGetColor ()
    Get method for attribute "Color"
     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*/ Vector3DGetDirection ()
    Get method for attribute "Direction"
     Direction of light source with respect to model coordinate system.
/*optional*/ BooleanGetIsActive ()
    Get method for attribute "IsActive"
     Checks if light source is active or not
/*optional*/ StringGetName ()
    Get method for attribute "Name"
     Name of the light source
/*optional*/ Point3DGetPosition ()
    Get method for attribute "Position"
     Position of light source with respect to model coordinate system.
/*optional*/ DoubleGetSpreadAngle ()
    Get method for attribute "SpreadAngle"
     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*/ LightTypeGetType ()
    Get method for attribute "Type"
     Type of the light source
voidSetCastShadows ( /*optional*/ Boolean value)
    Set method for attribute "CastShadows"
     Cast a shadow
voidSetColor ( /*optional*/ ColorRGB value)
    Set method for attribute "Color"
     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
voidSetDirection ( /*optional*/ Vector3D value)
    Set method for attribute "Direction"
     Direction of light source with respect to model coordinate system.
voidSetIsActive ( /*optional*/ Boolean value)
    Set method for attribute "IsActive"
     Checks if light source is active or not
voidSetName ( /*optional*/ String value)
    Set method for attribute "Name"
     Name of the light source
voidSetPosition ( /*optional*/ Point3D value)
    Set method for attribute "Position"
     Position of light source with respect to model coordinate system.
voidSetSpreadAngle ( /*optional*/ Double value)
    Set method for attribute "SpreadAngle"
     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.
voidSetType ( /*optional*/ LightType value)
    Set method for attribute "Type"
     Type of the light source

Method Detail

GetName/SetName

/*optional*/ StringGetName ()
voidSetName ( /*optional*/ String value)


     Name of the light source
Manual References:
Graphics: Setting Light Sources, Graphics: Setting Light Sources, Graphics: Setting Light Sources, Graphics: Setting Light Sources



GetType/SetType

/*optional*/ LightTypeGetType ()
voidSetType ( /*optional*/ LightType value)


     Type of the light source
Manual References:
Graphics: Setting Light Sources, Graphics: Setting Light Sources, Graphics: Setting Light Sources, Graphics: Setting Light Sources



GetIsActive/SetIsActive

/*optional*/ BooleanGetIsActive ()
voidSetIsActive ( /*optional*/ Boolean value)


     Checks if light source is active or not
Manual References:
Graphics: Setting Light Sources, Graphics: Setting Light Sources, Graphics: Setting Light Sources



GetColor/SetColor

/*optional*/ ColorRGBGetColor ()
voidSetColor ( /*optional*/ ColorRGB 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



GetPosition/SetPosition

/*optional*/ Point3DGetPosition ()
voidSetPosition ( /*optional*/ Point3D 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



GetDirection/SetDirection

/*optional*/ Vector3DGetDirection ()
voidSetDirection ( /*optional*/ Vector3D 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



GetSpreadAngle/SetSpreadAngle

/*optional*/ DoubleGetSpreadAngle ()
voidSetSpreadAngle ( /*optional*/ Double 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



GetCastShadows/SetCastShadows

/*optional*/ BooleanGetCastShadows ()
voidSetCastShadows ( /*optional*/ Boolean value)


     Cast a shadow
Manual References:
Graphics: Setting Light Sources, Graphics: Setting Light Sources, Graphics: Setting Light Sources, Graphics: Setting Light Sources