GDlight_info_xxxx

Synopsis

access the Graphics Display Kit light information

GDlight_info_get_xxxx

void _ GDlight_info_get_show ( light_info_id , _int _* show _);
void _ GDlight_info_get_amb_state ( light_info_id , _int _* amb_state _);
void _ GDlight_info_get_amb_color ( light_info_id , _float _* amb_color _);

OMobj_id _ light_info_id ;

GDlight_info_set_xxxx

void _ GDlight_info_set_show ( light_info_id , _int _ show _);
void _ GDlight_info_set_amb_state ( light_info_id , _int _ amb_state _);
void _ GDlight_info_set_amb_color ( light_info_id , _float _* amb_color _);

OMobj_id _ light_info_id ;

GDlight_info_xxxx_light

void _ GDlight_info_attach_light ( light_info_id , _ light_id, int flag );
void _ GDlight_info_detach_light ( light_info_id , _ light_id, int flag );

OMobj_id _ light_info_id , _ light_id ;

GDlight_info_delete

void _ GDlight_info_delete (
NULL,
OMobj_id _ light_info_id ,
0,
GDlight_info _* light_info _);

GDlight_info_reset

void _ GDlight_info_reset ( GDlight_info _* light_info );

Description

These routines are used to access the Graphics Display Kit light information.

The GDlight_info_get_xxxx routines get the subobject values of the light information. The GDlight_info_set_xxxx routines set the subobject values of the light infomation. These routines are used by the Graphics Display Kit light information editor (i.e., GDlinfo_edit).

GDlight_info_attach_light attaches a light to the light information. The light information maintains an array of lights. GDlight_detach_xform detaches the specified light from the light information.

GDlight_info_delete deletes the light information. This method is called directly by the Object Manager when light information is deleted.

GDlight_info_reset resets the light information's subobjects to their default values. The default values are those in specified in DefaultLightInfo.

To create an instance of light information, call the utility routine GDcreate_instance.

Parameters

light_info_id

The id of a light-information object.

Other get/set parameters

The other parameters in the get/set routines correspond to subobjects of the light-information object.

For details, see DefaultLightInfo .

The amb_color parameter is a three-element array.

light_id

(GDlight_info_attach/detach_light only) _The id of a light object.

light_info

(GDlight_info_delete only) _The light-information object's local pointer. To get this value, call the utility routine GDget_local.

flag

(GDlight_info_attach/detach_light only). This argument controls whether the routine attaches the light to the light information: 0 means no; 1 means yes. In normal usage within the Graphics Display Kit, the flag is set to 0. If you are using the routines programatically, set the flag to 1.

Example

/* Get and set a light-information object's show subobject. */
OMobj_id light_info_id; /* Assume this has been set. */
int show;
...
GDlight_info_get_show(light_info_id, &show);
show = 1;
GDlight_info_set_show(light_info_id, show);