Brief Index      Full Index      Events Index      I.M. Reference

Show_Key_Type

Functions

void Show_Key_Type (HC_KEY key, char *type)
void Show_Key_Status (HC_KEY key, char *status)

Function Documentation

void Show_Key_Type ( HC_KEY  key,
char *  type 
)

Returns the type of object referenced by a key.

Parameters:
key- Unique numeric identifier pointing to an object in the database.
type- Classification of object referenced by key. Returned to caller. Passed by reference always.

DETAILS

You can find out what kind of object was chosen in a Show_Selection_Element() operation, or found by a Begin_Contents_Search() , or added to the database in a previous Insert or Open_Segment() by using this command.

The type returned can be either geometry or one of the various segment or include types.

The following is a table of geometry types that can be returned:

circle circular arc circular chord circular wedge
circular plane circular section cylinder ellipse
elliptical arc grid image line
area light distant light local light spot light
marker mesh cylinder nurbs curve
nurbs surface polygon polyline polycylinder
shell sphere text

The following is a table of segment types that can be returned:

segment include reference geometry style

Given the type returned by this function, you can use a Show routine such as Show_Line() to determine the details of the geometry, or Show_Segment() to determine the name of the segment pointed to by key. The status field can be valid (normal), invalid (deleted), local or global (renumbered).

NOTES

If key is invalid, unpredictable results will ensue. Don't rely on HOOPS being able to protect you from invalid keys.

RESTRICTIONS

See also:
Show_Existence, Show_Owner, Begin_Contents_Search, Get_Selection, Insert_Line, Open_Segment, Show_Polyline, Show_Shell, Show_Marker.
void Show_Key_Status ( HC_KEY  key,
char *  status 
)

Helps to maintain lists of valid keys.

Parameters:
key- Unique numeric identifier pointing to an object in the database.
status- Status of the key: valid, invalid, local, or global. Returned to caller. Passed by reference always.

DETAILS

No additional details.

Brief Index      Full Index      Events Index      I.M. Reference