Light Source

Manages graphic light sources.

ga_light_attenuation_get	( name, value )

Description:
Get the attenuation of the light.
Input:
STRING	name[]	Light source name.
Output:
REAL	value	Attenuation of light (0.0-1.0).
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000037	The light source name is invalid.
11000104	The specified light source was not found in the database.
11000098	A fatal error has occurred in the database. Database is corrupted.

Please see ga_light_attenuation_get (p. 104) in the MSC Acumen Toolkit - Code Examples.

ga_light_attenuation_set	( name, value )

Description:
Set the attenuation of the light.
Input:
STRING	name[]	Light source name.
REAL	value	Attenuation of light (0.0-1.0).
Output:
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000037	The light source name is invalid.
11000104	The specified light source was not found in the database.
11000098	A fatal error has occurred in the database. Database is corrupted.

Please see ga_light_attenuation_set (p. 105) in the MSC Acumen Toolkit - Code Examples.

ga_light_color_get	( name, index )

Description:
Get the light source color.
Input:
STRING	name[]	Light source name.
Output:
INTEGER	index	Light color.
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000037	The light source name is invalid.
11000104	The specified light source was not found in the database.
11000098	A fatal error has occurred in the database. Database is corrupted.

Please see ga_light_color_get (p. 106) in the MSC Acumen Toolkit - Code Examples.

ga_light_color_set	( name, index )

Description:
Set the light source color.
Input:
STRING	name	Light source name.
INTEGER	index	Light source color index.
Output:
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000037	The light source name is invalid.
11000086	The color index for the current lookup table is out of range.
11000104	The specified light source was not found in the database.
11000098	A fatal error has occurred in the database. Database is corrupted.

See example for ga_light_attenuation_set, 45. See also ga_light_color_set (p. 108) in the MSC Acumen Toolkit - Code Examples.

ga_light_create	( name )

Description:
Creates a light source.
Input:
STRING	name	Name of light source.
Output:
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000037	The light source name is invalid.
11000036	A light source with the given name is already in the database.
11000097	There is not enough disk space to complete operation.
11000098	A fatal error has occurred in the database. Database is corrupted.

Please see ga_light_create (p. 109) in the MSC Acumen Toolkit - Code Examples.

ga_light_delete	( name )

Description:
Delete a light source.
Input:
STRING	name[]	Name of light source.
Output:
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000037	The light source name is invalid.
11000104	The specified light source was not found in the database.
11000098	A fatal error has occurred in the database. Database is corrupted.

Please see ga_light_delete (p. 111) in the MSC Acumen Toolkit - Code Examples.

ga_light_direction_get	( name, value )

Description:
Get the light source direction.
Input:
STRING	name	Light source name.
Output:
REAL	value (3)	Direction of light source.
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000037	The light source name is invalid.
11000104	The specified light source was not found in the database.
11000098	A fatal error has occurred in the database. Database is corrupted.

Please see ga_light_direction_get (p. 112) in the MSC Acumen Toolkit - Code Examples.

ga_light_direction_set	( name, value )

Description:
Set the light source direction.
Input:
STRING	name[]	Light source name.
REAL	value (3)	Direction of light source.
Output:
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000037	The light source name is invalid.
11000104	The specified light source was not found in the database.
11000098	A fatal error has occurred in the database. Database is corrupted.

See example for ga_light_attenuation_set, 45. See also ga_light_direction_set (p. 114) in the MSC Acumen Toolkit - Code Examples.

ga_light_icon_get	( name, value )

Description:
Get the status whether the icon is displayed.
Input:
STRING	name[]	Light source name.
Output:
INTEGER	value	Flag specifying if an icon should be displayed at light source.
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000037	The light source name is invalid.
11000104	The specified light source was not found in the database.
11000098	A fatal error has occurred in the database. Database is corrupted.

ga_light_icon_set	( name, value )

Description:
Set the status whether the icon is displayed.
Input:
STRING	name[]	Light source name.
INTEGER	value	Flag specifying if an icon should be displayed at light source.
Output:
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000037	The light source name is invalid.
11000104	The specified light source was not found in the database.
11000098	A fatal error has occurred in the database. Database is corrupted.

See example for ga_light_attenuation_set, 45. See also ga_light_icon_set (p. 116) in the MSC Acumen Toolkit - Code Examples.

ga_light_intensity_get	( name, value )

Description:
Get the intensity of the light.
Input:
STRING	name[]	Light source name.
Output:
REAL	value	Intensity of light (0.0-1.0).
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000037	The light source name is invalid.
11000104	The specified light source was not found in the database.
11000098	A fatal error has occurred in the database. Database is corrupted.

Please see ga_light_intensity_get (p. 118) in the MSC Acumen Toolkit - Code Examples.

ga_light_intensity_set	( name, value )

Description:
Set the intensity of the light.
Input:
STRING	name[]	Light source name.
REAL	value	Intensity of light (0.0-1.0).
Output:
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000037	The light source name is invalid.
11000104	The specified light source was not found in the database.
11000098	A fatal error has occurred in the database. Database is corrupted.

See example for ga_light_attenuation_set, 45. See also ga_light_intensity_set (p. 119) in the MSC Acumen Toolkit - Code Examples.

ga_light_lights_get	( lights_list )

Description:
Gets the list of lights.
Input:
None.
Output:
STRING	lights_list [ ] ( )	List of lights.
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000098	A fatal error has occurred in the database. Database is corrupted.

Please see ga_light_lights_get (p. 121) in the MSC Acumen Toolkit - Code Examples.

ga_light_location_get	( name, value )

Description:
Get the location of light source.
Input:
STRING	name[]	Light source name.
Output:
REAL	value (3)	Location of light source (x,y,z).
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000037	The light source name is invalid.
11000104	The specified light source was not found in the database.
11000098	A fatal error has occurred in the database. Database is corrupted.

Please see ga_light_location_get (p. 122) in the MSC Acumen Toolkit - Code Examples.

ga_light_location_set	( name, value )

Description:
Set the location of light source.
Input:
STRING	name[]	Light source name.
REAL	value (3)	Location of light source (x,y,z).
Output:
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000037	The light source name is invalid.
11000104	The specified light source was not found in the database.
11000098	A fatal error has occurred in the database. Database is corrupted.

See example for ga_light_attenuation_set, 45. See also ga_light_location_set (p. 123) in the MSC Acumen Toolkit - Code Examples.

ga_light_movement_get	( name, value )

Description:
Get whether the light moves with the model or not.
Input:
STRING	name[]	Light source name.
Output:
INTEGER	value	Flag specifying whether light moves with the model or not.
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000037	The light source name is invalid.
11000104	The specified light source was not found in the database.
11000098	A fatal error has occurred in the database. Database is corrupted.

Please see ga_light_movement_get (p. 125) in the MSC Acumen Toolkit - Code Examples.

ga_light_movement_set	( name, value )

Description:
Set the status whether the light should move with the model.
Input:
STRING	name[]	Light source name.
INTEGER	value	Flag specifying if the light should move with the model.
Output:
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000037	The light source name is invalid.
11000104	The specified light source was not found in the database.
11000098	A fatal error has occurred in the database. Database is corrupted.

See example for ga_light_attenuation_set, 45. See also ga_light_movement_set (p. 126) in the MSC Acumen Toolkit - Code Examples.

ga_light_nlights_get	( nlights )

Description:
Gets the number of lights.
Input:
None.
Output:
INTEGER	nlights	Number of lights.
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000098	A fatal error has occurred in the database. Database is corrupted.

Please see ga_light_nlights_get (p. 128) in the MSC Acumen Toolkit - Code Examples.

ga_light_nposted_get	( nlights )

Description:
Gets the number of posted lights.
Input:
None.
Output:
INTEGER	nlights	Number of posted lights.
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000098	A fatal error has occurred in the database. Database is corrupted.

Please see ga_light_nposted_get (p. 129) in the MSC Acumen Toolkit - Code Examples.

ga_light_post	( name )

Description:
Post a light source.
Input:
STRING	name[]	Name of light source.
Output:
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000037	The light source name is invalid.
11000104	The specified light source was not found in the database.
11000098	A fatal error has occurred in the database. Database is corrupted.

Please see ga_light_post (p. 130) in the MSC Acumen Toolkit - Code Examples.

ga_light_posted_get	( lights_list )

Description:
Gets the list of posted lights.
Input:
None.
Output:
STRING	lights_list [ ] ( )	List of lights.
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000098	A fatal error has occurred in the database. Database is corrupted.

Please see ga_light_posted_get (p. 131) in the MSC Acumen Toolkit - Code Examples.

ga_light_type_get	( name, value )

Description:
Get the light source type.
Input:
STRING	name[]	Light source name.
Output:
STRING	value[]	Type.
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000037	The light source name is invalid.
11000104	The specified light source was not found in the database.
11000098	A fatal error has occurred in the database. Database is corrupted.

Please see ga_light_type_get (p. 132) in the MSC Acumen Toolkit - Code Examples.

ga_light_type_set	( name, value )

Description:
Set the light source type.
Input:
STRING	name[]	Light source name.
STRING	value[]	Light source type.
Output:
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000037	The light source name is invalid.
11000104	The specified light source was not found in the database.
11000098	A fatal error has occurred in the database. Database is corrupted.

Please see ga_light_type_set (p. 134) in the MSC Acumen Toolkit - Code Examples.

ga_light_unpost	( name )

Description:
Unpost a light source.
Input:
STRING	name[]	Name of light source.
Output:
INTEGER	<Return Value>	See error conditions.
Error Conditions:
11000037	The light source name is invalid.
11000104	The specified light source was not found in the database.
11000098	A fatal error has occurred in the database. Database is corrupted.

Please see ga_light_unpost (p. 135) in the MSC Acumen Toolkit - Code Examples.