GDprops_xxxx- GD API

Synopsis

access the Graphics Display Kit properties

GDprops_get_xxxx

void   GDprops_get_color ( props_id ,  float  * color  );
void   GDprops_get_hi1_col ( props_id ,  float  * color  );
void   GDprops_get_hi2_col ( props_id ,  float  * color  );
void   GDprops_get_material ( props_id ,  float  * material  );
void   GDprops_get_specular_color ( props_id ,  float  * color  );
void   GDprops_get_transparency ( props_id ,  float  * transparency  );
void   GDprops_get_draw_mode ( props_id ,  int  * draw_mode  );
void   GDprops_get_line_width ( props_id ,  int  * line_width );
void   GDprops_get_line_style ( props_id ,  int  * line_style  );
void   GDprops_get_line_aa ( props_id ,  int  * line_aa  );
void   GDprops_get_dir_pt_size ( props_id ,  float  * dir_pt_size );
void   GDprops_get_subdiv ( props_id ,  int  * subdiv  );
void   GDprops_get_cull ( props_id ,  int  * cull  );
void   GDprops_get_inherit ( props_id ,  int  * inherit  );

OMobj_id   props_id ;

GDprops_set_xxxx

void   GDprops_set_color ( props_id ,  float  * color  );
void   GDprops_set_hi1_col ( props_id ,  float  * color  );
void   GDprops_set_hi2_col ( props_id ,  float  * color  );
void   GDprops_set_material ( props_id ,  float  * material  );
void   GDprops_set_specular_color ( props_id ,  float  * color  );
void   GDprops_set_transparency ( props_id ,  float   transparency  );
void   GDprops_set_draw_mode ( props_id ,  int   draw_mode  );
void   GDprops_set_line_width ( props_id ,  int   line_width );
void   GDprops_set_line_style ( props_id ,  int   line_style  );
void   GDprops_set_line_aa ( props_id ,  int   line_aa  );
void   GDprops_set_dir_pt_size ( props_id ,  float   dir_pt_size );
void   GDprops_set_subdiv ( props_id ,  int   subdiv  );
void   GDprops_set_cull ( props_id ,  int   cull  );
void   GDprops_set_inherit ( props_id ,  int   inherit  );

OMobj_id   props_id ;

GDprops_delete

void   GDprops_delete ( OMobj_id   props_id  );

GDprops_reset

void   GDprops_reset ( OMobj_id   props_id );

Description

These routines are used to access the Graphics Display Kit properties.

The GDprops_get_xxxx routines get the subobject values of the properties. The GDprops_set_xxxx routines set the subobject values of the properties. These routines are used by the Graphics Display Kit properties editor (i.e., GDprops_edit).

GDprops_delete deletes the properties. This method is called directly by the Object Manager when the properties are deleted.

GDprops_reset resets the properties subobjects to their default values. The default values are those in specified in DefaultProps.

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

Parameters

props_id

The id of the properties.

Other get/set parameters

The other parameters in the get/set routines correspond to subobjects of the properties. Symbolic constants are available for the parameters.

For details, including a list of symbolic constants, see DefaultProps .

The material parameter is a four-element array.

The color, hi1_color, hi2_color and specular_color parameters are three-element arrays.

Example

/* Get and set a properties object's material subobject. */
OMobj_id props_id; /* Assume this has been set. */
int material[4];
...
GDprops_get_material(props_id, material);
material[0] *= 0.9;
GDprops_set_material(props_id, material);