All Frameworks  Class Hierarchy  This Framework  Indexes

SPArbase Global Function api_rh_get_entity_rgb

outcome api_rh_get_entity_rgb(	ENTITY*	`ent`,
	rgb_color&	`color`,
	logical	`inherit`,
	logical&	`found`)

Gets the RGB color of an entity.

Role: Searches the entity for one of four color attributes. Color precendence is as follows:
ATTRIB_RGB
ATTRIB_COL
ATTRIB_RENDER
ATTRIB_IGES_COLOR

If none of these attributes are found on the given entity and the inherit flag is set, the given entity's owner is examined in the same manner and so on up the hierarchy.

If no color attribute is found, the 'found' flag will be FALSE and the color <-1, -1, -1> is returned. (A color of <-1, -1, -1> means that a color is not specified for the given entity.)

Effect: Read-only

Journal: Not Available

Parameters:

ent: entity to change.
color: color returned.
inherit: inherit color from owner?
found: Flag indicating that the color was explicitly set.

This object is included in the file: rnd_api.hxx