Introduction

Getting Started

Programming Guides

API Reference

Additional Resources

Show_Optimized_Mapping

Functions

void Show_Optimized_Mapping (const char *segname, const char *direction, HC_KEY in_owner, HC_KEY in_key, int in_region, HC_KEY *out_owner, HC_KEY *out_key, int *out_region)
 Allows a user to map a piece of geometry between an old segment tree and a new segment tree (or vice-versa) that has been generated during a call to Optimize_Segment_Tree(). More...
 

Detailed Description

Function Documentation

void Show_Optimized_Mapping ( const char *  segname,
const char *  direction,
HC_KEY  in_owner,
HC_KEY  in_key,
int  in_region,
HC_KEY out_owner,
HC_KEY out_key,
int *  out_region 
)

Allows a user to map a piece of geometry between an old segment tree and a new segment tree (or vice-versa) that has been generated during a call to Optimize_Segment_Tree().

Parameters
segname- The segment on which the optimization was originally performed.
direction- String indicating whether the in_owner key is from a segment tree that is pre- or post-optimization. Passing in "forward" indicates that in_owner is from a pre-optimized tree, while "backward" indicate that in_owner is from a post-optimized tree.
in_owner- Key to the segment in which in_key resides in the starting tree. This is only required if in_key happens to be a locally renumbered key. If locally renumbered keys are not being used, then simply pass in the special value of -1.
in_key- Key to the geometry for which a mapping is requested. This must be the key to a piece of geometry. Segment and Include keys will cause a warning to be issued.
in_region- Optional argument that defines the index of the desired region within the shell defined by in_owner.
out_owner- Key to the segment in which in_owner resides in the complementary segment tree. Passed by reference. Returned to user.
out_key- Key to the piece of geometry the complementary segment tree. Passed by reference. Returned to user.
out_region- Optional argument that returns the index of the region within out_key that maps to the shell/region specified in in_owner (and optionally in_region). Passed by reference. Returned to user.

DETAILS

Depending on the options set before the call to Optimize_Segment_Tree(), geometry will have been moved around the segment hierarchy. Furthermore, if the "merge shells" setting has been set, then Shells will have migrated from individual Shells to a regions within a larger Shell. This function allows the user to map geometry between the segment trees that exist before and after Optimize_Segment_Tree().

NOTES

Only geometry may be specified in the in_owner key.

See also
Optimize_Segment_Tree, Insert_Shell_From_Region, Open_Region