Gather_Capping_Geometry

Functions

int Gather_Capping_Geometry (int key_count, Key const *path_keys, Key cut_key, char const *options)
 Collects capping geometry generated by cutting planes. Geometry is deposited into the currently open segment. The capping faces are delivered in the form of shells, and edges are delivered as polylines. More...
 

Detailed Description

Function Documentation

◆ Gather_Capping_Geometry()

int Gather_Capping_Geometry ( int  key_count,
Key const *  path_keys,
Key  cut_key,
char const *  options 
)

Collects capping geometry generated by cutting planes. Geometry is deposited into the currently open segment. The capping faces are delivered in the form of shells, and edges are delivered as polylines.

Parameters
key_count- The number of keys in the path
path_keys- An array of keys, from the target segment up to a driver. Also possible to pass a single segment key
cut_key- The key of a single cutting section or plane to collect for. Passing INVALID_KEY will collect for all cutting sections and planes
options- A quoted string or a string variable containing a list of the desired options
Returns
The number of shells and lines inserted

DETAILS

Parameter "options" can be of the following:

  • "segment only" - Collect capping geometry only for the target segment, not any of its subsegments. By default, capping geometry is collected from the entire subtree starting at the target segment.
  • "ignore matrix" - When inserting capping geometry, do not accumulate modelling matrices. By default, modelling matrices are considered.
  • "section offset" - Allows specifying of a plane offset into a cutting section. By default, all planes in a cutting section are collected.
  • "refine cuts" - Determines whether capping geometry should be refined by cutting it against all other planes in the scene. By default capping geometry is only cut by the single plane that generated it.