Brief Index      Full Index      I.M. Reference

Conditional_Reference


Functions

void Conditional_Reference (const char *segname, const char *condition)
HC_KEY KConditional_Reference (const char *segname, const char *condition)
void Conditional_Reference_By_Key (HC_KEY geom_key, const char *condition)
HC_KEY KConditional_Reference_By_Key (HC_KEY geom_key, const char *condition)

Function Documentation

void Conditional_Reference ( const char *  segname,
const char *  condition 
)

Directs HOOPS to create a reference to some geometry when processing a segment, subject to meeting the conditions set on the segment in a previous call to Set_Conditions()..

Parameters:
segname - Name, possibly including wildcards and lists, of extra segment(s) from which the geometry should be included when displaying the current segment.
condition - The condition(s) that are associated with a particular conditional include, and that are valid input to Set_Conditions().

DETAILS

This "Conditional" variant of Reference_Geometry() allows the user to register one or a series of conditions that must match with the conditions set on the owning or referencing segment ( see Set_Conditions() ), in order for the reference to apply. The conditions are user-defined and have no internal meaning to HOOPS other than as elements that can be compared. Conditions are inherited down the tree like other regular attributes, and are resolved at draw time.

In all other respects, this function is identical to Reference_Geometry().

See also:
Copy_Geometry, Open_Geometry, Reference_Geometry, Set_Conditions, KShow_Conditional_Reference, KShow_Reference_Geometry

HC_KEY KConditional_Reference ( const char *  segname,
const char *  condition 
)

Similar to Conditional_Reference(), but returns a key to the reference that can be used lated to delete the reference.

Parameters:
segname - Name, possibly including wildcards and lists, of extra segment(s) from which the geometry should be included when displaying the current segment.
condition - The condition(s) that are associated with a particular conditional include, and that are valid input to Set_Conditions().
Returns:
reference_key Unique numeric identifier to the reference. This is not the same as the key of the geometry being referenced.

DETAILS

No additional details. See Conditional_Reference().

void Conditional_Reference_By_Key ( HC_KEY  geom_key,
const char *  condition 
)

Similar to Conditional_Reference(), but references a particular item, rather than a segment and all of its contents.

Parameters:
geom_key - Key to the geometry that should be included when displaying the current segment.
condition - The condition(s) that are associated with a particular conditional include, and that are valid input to Set_Conditions().

DETAILS

No additional details. See Conditional_Reference().

HC_KEY KConditional_Reference_By_Key ( HC_KEY  geom_key,
const char *  condition 
)

Similar to KConditional_Reference_By_Key(), but returns a key to the reference that can be used lated to delete the reference.

Parameters:
geom_key - Key to the geometry that should be included when displaying the current segment.
condition - The condition(s) that are associated with a particular conditional include, and that are valid input to Set_Conditions().
Returns:
reference_key Unique numeric identifier to the reference. This is not the same as the key of the geometry being referenced.

DETAILS

No additional details. See Conditional_Reference().

Main Index
Brief Index      Full Index      I.M. Functions