CuttingSection
- class HPS.CuttingSection : public IDisposable
The CuttingSection class is a concept class for cutting-section-related enum classes.
Public Types
- enum CappingLevel
Enumerates the level at which capping geometry should be generated for cutting sections.
Values:
- Entity
Each piece of geometry should be treated as if it encloses a volume.
- Segment
All geometry in a segment (but not subsegments) should be treated as if it encloses a single volume.
- SegmentTree
All geometry in a segment tree should be treated as if it encloses a single volume.
- enum CappingUsage
Enumerates the choices for whether geometry (faces) are cut and processed for capping geometry.
Values:
- Off
Faces will not be used for capping.
- On
Faces will be used for capping generation.
- Visibility
Faces will be used for capping generation if they are visible.
- enum CuttingLevel
Enumerates the level at which cutting planes should operate.
Values:
- Global
Cutting sections will cut all geometry in the scene graph.
- Local
Cutting sections will only cut geometry contained in the segment and subsegments where the cutting section is inserted.
- enum GatheringLevel
Enumerates the level at which capping geometry should be gathered.
Values:
- Segment
Capping geometry will be gathered only from a single segment.
- SegmentTree
Capping geometry will be gathered from the segment and all its subsegments and includes.
- enum MaterialPreference
Enumerates which material settings should be used for cut geometry generated for cutting sections.
Values:
- Explicit
Use the effective materials set for cut faces and cut edges in the segment tree. For example, the following function applies color settings that would be respected when MaterialPreference is set to Explicit: mySegmentKey.GetMaterialMappingControl().SetCutFaceColor(myRGBAColor).SetCutEdgeColor(myRGBAColor)
- Implicit
Use the effective materials set for (regular) faces and (regular) edges in the segment tree. For Segment or SegmentTree CappingLevel, the implicit capping geometry face color will be the weighted average of the geometry face colors where the cut is applied. For example, the following function applies color settings that would be respected when MaterialPreference is set to Implicit: mySegmentKey.GetMaterialMappingControl().SetFaceColor(myRGBAColor).SetEdgeColor(myRGBAColor)
- enum Mode
Enumerates the modes for cutting sections. These are the shapes (if any) of the visualization geometry that will be drawn to represent cutting planes within cutting sections.
Values:
- None
No visualization geometry will be drawn for cutting planes in a cutting sections.
- Round
A circular plane will be drawn for cutting planes in a cutting section. The size of the planes will be based on the size of the geometry being cut and the visualization scale.
- Square
A square plane will be drawn for cutting planes in a cutting section. The size of the planes will be based on the size of the geometry being cut and the visualization scale.
- Plane
An infinitely large plane will be drawn for cutting planes in a cutting section.
