#include <hps.h>

Public Member Functions | |
KeyPath & | Append (Key const &in_key) |
KeyPath & | Append (KeyPath const &in_key_path) |
KeyPath & | Append (KeyArray const &in_key_array) |
bool | ComputeExtent (Rectangle &out_extent) const |
bool | ComputeExtent (HPS::VisibilityKit const &in_vis, Rectangle &out_extent) const |
bool | ComputeExtent (HPS::Extent::ClipRegion in_clip, Rectangle &out_extent) const |
bool | ComputeExtent (HPS::VisibilityKit const &in_vis, HPS::Extent::ClipRegion in_clip, Rectangle &out_extent) const |
bool | ComputeTextExtent (char const *in_text, float &out_xfrac, float &out_yfrac) const |
bool | ComputeTransform (Coordinate::Space in_space, Coordinate::Space in_output_space, HPS::MatrixKit &out_matrix) const |
bool | ConvertCoordinate (Coordinate::Space in_space, Point const &in_point, Coordinate::Space in_output_space, Point &out_point) const |
bool | ConvertCoordinate (Coordinate::Space in_space, PointArray const &in_points, Coordinate::Space in_output_space, PointArray &out_points) const |
bool | Equals (KeyPath const &in_that) const |
size_t | GatherCutGeometry (SegmentKey const &in_destination, CutGeometryGatheringOptionsKit const &in_options) const |
KeyPath () | |
KeyPath (KeyArray const &in_path) | |
KeyPath (size_t in_path_count, Key const in_path[]) | |
KeyPath (KeyPath const &in_that) | |
KeyPath (KeyPath &&in_that) | |
HPS::Type | ObjectType () const |
bool | operator!= (KeyPath const &in_that) const |
KeyPath & | operator+= (Key const &in_key) |
KeyPath & | operator+= (KeyPath const &in_key_path) |
KeyPath & | operator+= (KeyArray const &in_key_array) |
KeyPath & | operator= (KeyPath &&in_that) |
KeyPath & | operator= (KeyPath const &in_that) |
KeyPath & | operator= (KeyArray const &in_path) |
bool | operator== (KeyPath const &in_that) const |
void | Set (KeyPath const &in_that) |
KeyPath & | SetKeys (KeyArray const &in_keys) |
KeyPath & | SetKeys (size_t in_key_count, Key const in_keys[]) |
bool | ShowEffectiveGlyphDefinition (char const *in_name, GlyphDefinition &out_def) const |
bool | ShowEffectiveImageDefinition (char const *in_name, ImageDefinition &out_def) const |
bool | ShowEffectiveLinePatternDefinition (char const *in_name, LinePatternDefinition &out_def) const |
bool | ShowEffectiveMaterialPaletteDefinition (char const *in_name, MaterialPaletteDefinition &out_def) const |
bool | ShowEffectiveShaderDefinition (char const *in_name, ShaderDefinition &out_def) const |
bool | ShowEffectiveTextureDefinition (char const *in_name, TextureDefinition &out_def) const |
bool | ShowKeys (KeyArray &out_keys) const |
bool | ShowNetAttributeLock (AttributeLockKit &out_kit) const |
bool | ShowNetBounding (BoundingKit &out_kit) const |
bool | ShowNetCamera (CameraKit &out_kit) const |
bool | ShowNetClipRegions (PointArrayArrayArray &out_loops_array, ClipSpaceArray &out_spaces, ClipOperationArray &out_operations, MatrixKitArray &out_matrices) const |
bool | ShowNetColorInterpolation (ColorInterpolationKit &out_kit) const |
bool | ShowNetConditions (UTF8Array &out_conditions) const |
bool | ShowNetContourLine (ContourLineKit &out_kit) const |
bool | ShowNetCulling (CullingKit &out_kit) const |
bool | ShowNetCurveAttribute (CurveAttributeKit &out_kit) const |
bool | ShowNetCuttingSectionAttribute (CuttingSectionAttributeKit &out_kit) const |
bool | ShowNetCylinderAttribute (CylinderAttributeKit &out_kit) const |
bool | ShowNetDrawingAttribute (DrawingAttributeKit &out_kit) const |
bool | ShowNetEdgeAttribute (EdgeAttributeKit &out_kit) const |
bool | ShowNetHiddenLineAttribute (HiddenLineAttributeKit &out_kit) const |
bool | ShowNetLightingAttribute (LightingAttributeKit &out_kit) const |
bool | ShowNetLineAttribute (LineAttributeKit &out_kit) const |
bool | ShowNetMarkerAttribute (MarkerAttributeKit &out_kit) const |
bool | ShowNetMaterialMapping (MaterialMappingKit &out_kit) const |
bool | ShowNetMaterialPalette (UTF8 &out_name) const |
bool | ShowNetModellingMatrix (MatrixKit &out_kit) const |
bool | ShowNetNURBSSurfaceAttribute (NURBSSurfaceAttributeKit &out_kit) const |
bool | ShowNetPerformance (PerformanceKit &out_kit) const |
bool | ShowNetSelectability (SelectabilityKit &out_kit) const |
bool | ShowNetSphereAttribute (SphereAttributeKit &out_kit) const |
bool | ShowNetSubwindow (SubwindowKit &out_kit) const |
bool | ShowNetTextAttribute (TextAttributeKit &out_kit) const |
bool | ShowNetTextureMatrix (MatrixKit &out_kit) const |
bool | ShowNetTransformMask (TransformMaskKit &out_kit) const |
bool | ShowNetTransparency (TransparencyKit &out_kit) const |
bool | ShowNetVisibility (VisibilityKit &out_kit) const |
bool | ShowNetVisualEffects (VisualEffectsKit &out_kit) const |
KeyPath & | UnsetKeys () |
virtual | ~KeyPath () |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
virtual HPS::Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
The KeyPath contains an array of keys, organized from leaf to root. It allows the user to perform a number of queries along that path including accumulating net attributes and converting coordinates.
Constructor & Destructor Documentation
HPS::KeyPath::KeyPath | ( | ) |
Creates an uninitialized key path that refers to no database objects.
HPS::KeyPath::KeyPath | ( | KeyArray const & | in_path | ) |
Creates a new KeyPath object based on the supplied path.
- Parameters
-
in_path An array of keys arranged from leaf to root.
HPS::KeyPath::KeyPath | ( | size_t | in_path_count, |
Key const | in_path[] | ||
) |
Creates a new KeyPath object based on the supplied path.
- Parameters
-
in_path_count The number of keys in the array. in_path An array of keys arranged from leaf to root.
HPS::KeyPath::KeyPath | ( | KeyPath const & | in_that | ) |
Copies in_that into this key path.
HPS::KeyPath::KeyPath | ( | KeyPath && | in_that | ) |
|
virtual |
Releases a reference to the database object this object is tied to.
Member Function Documentation
Appends the supplied key into this object. Same as operator+= function.
- Parameters
-
in_key_path The KeyPath to be appended to this.
- Returns
- A reference to this object.
KeyPath& HPS::KeyPath::Append | ( | KeyArray const & | in_key_array | ) |
Appends the supplied key into this object. Same as operator+= function.
- Parameters
-
in_key_array The KeyArray to be appended to this.
- Returns
- A reference to this object.
bool HPS::KeyPath::ComputeExtent | ( | Rectangle & | out_extent | ) | const |
Computes a tight 2D extents box around the geometry contained in this key path. A user can use this information to tightly fit a camera to a specified segment or draw a 2D box around the segment. The coordinates are returned to the user in screen space.
- Parameters
-
out_extent The screen extent of the geometry under this key path.
- Returns
- true if the operation succeeded, false otherwise.
bool HPS::KeyPath::ComputeExtent | ( | HPS::VisibilityKit const & | in_vis, |
Rectangle & | out_extent | ||
) | const |
Computes a tight 2D extents box around the geometry contained in this key path. A user can use this information to tightly fit a camera to a specified segment or draw a 2D box around the segment. The coordinates are returned to the user in screen space.
- Parameters
-
in_vis Explicit visibility settings to acknowledge instead of using the visibilities resolved by this key path. out_extent The screen extent of the geometry under this key path.
- Returns
- true if the operation succeeded, false otherwise.
bool HPS::KeyPath::ComputeExtent | ( | HPS::Extent::ClipRegion | in_clip, |
Rectangle & | out_extent | ||
) | const |
Computes a tight 2D extents box around the geometry contained in this key path. A user can use this information to tightly fit a camera to a specified segment or draw a 2D box around the segment. The coordinates are returned to the user in screen space.
- Parameters
-
in_clip The setting which indicates whether clip regions should be ignored or included. out_extent The screen extent of the geometry under this key path.
- Returns
- true if the operation succeeded, false otherwise.
bool HPS::KeyPath::ComputeExtent | ( | HPS::VisibilityKit const & | in_vis, |
HPS::Extent::ClipRegion | in_clip, | ||
Rectangle & | out_extent | ||
) | const |
Computes a tight 2D extents box around the geometry contained in this key path. A user can use this information to tightly fit a camera to a specified segment or draw a 2D box around the segment. The coordinates are returned to the user in screen space.
- Parameters
-
in_vis Explicit visibility settings to acknowledge instead of using the visibilities resolved by this key path. in_clip The setting which indicates whether clip regions should be ignored or included. out_extent The screen extent of the geometry under this key path.
- Returns
- true if the operation succeeded, false otherwise.
bool HPS::KeyPath::ComputeTextExtent | ( | char const * | in_text, |
float & | out_xfrac, | ||
float & | out_yfrac | ||
) | const |
Computes the extents of the specified text string based on the effective text attributes along this key path. If the effective text transform setting is Text::Transform::Transformable, the returned values will be in object space units. For any other effective text transform setting, the returned values will be a fraction of the segment window from 0.0 to 1.0 (or more) along this key path.
- Parameters
-
in_text The text to measure along this keypath out_xfrac The width of the text extent out_yfrac The height of the text extent
- Returns
- true if the operation succeeded, false otherwise.
bool HPS::KeyPath::ComputeTransform | ( | Coordinate::Space | in_space, |
Coordinate::Space | in_output_space, | ||
HPS::MatrixKit & | out_matrix | ||
) | const |
Computes the matrix which transforms objects from the input space to the output space along this key path.
- Parameters
-
in_space The starting or input coordinate space. in_output_space The final or output coordinate space. out_matrix The matrix which transforms objects from the input space to the output space.
- Returns
- true if the operation succeeded, false otherwise.
bool HPS::KeyPath::ConvertCoordinate | ( | Coordinate::Space | in_space, |
Point const & | in_point, | ||
Coordinate::Space | in_output_space, | ||
Point & | out_point | ||
) | const |
Converts a point from one coordinate space to another using the transforms along this key path.
- Parameters
-
in_space The coordinate space of the input point. in_point The input point to convert. in_output_space The coordinate space to convert the input point into. out_point The output point, after conversion.
- Returns
- true if the operation succeeded, false otherwise.
bool HPS::KeyPath::ConvertCoordinate | ( | Coordinate::Space | in_space, |
PointArray const & | in_points, | ||
Coordinate::Space | in_output_space, | ||
PointArray & | out_points | ||
) | const |
Converts a point from one coordinate space to another using the transforms along this key path.
- Parameters
-
in_space The coordinate space of the input point. in_points The input points to convert. in_output_space The coordinate space to convert the input point into. out_points The output points, after conversion.
- Returns
- true if the operation succeeded, false otherwise.
bool HPS::KeyPath::Equals | ( | KeyPath const & | in_that | ) | const |
size_t HPS::KeyPath::GatherCutGeometry | ( | SegmentKey const & | in_destination, |
CutGeometryGatheringOptionsKit const & | in_options | ||
) | const |
Collects capping geometry generated by cutting planes. Geometry is deposited in the segment you specify. Note: Capping geometry is generated during an update. Until an update is completed, no geometry will be present to gather.
- Parameters
-
in_destination A segment that the capping geometry will be deposited into. in_options Options for the gathering operation.
- Returns
- The number of individual caps created.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Object.
bool HPS::KeyPath::operator!= | ( | KeyPath const & | in_that | ) | const |
Appends the supplied Key into this object. Same as Append function.
- Parameters
-
in_key The key to be appended to this.
- Returns
- A reference to this object.
KeyPath& HPS::KeyPath::operator+= | ( | KeyArray const & | in_key_array | ) |
Appends the supplied KeyArray into this object. Same as Append function.
- Parameters
-
in_key_array The KeyArray to be appended to this.
- Returns
- A reference to this object.
Copies the supplied path into this object.
- Parameters
-
in_that The source of the copy.
- Returns
- A reference to this object.
KeyPath& HPS::KeyPath::operator= | ( | KeyArray const & | in_path | ) |
Copies an array of keys into this object.
- Parameters
-
in_path The source array, assumed to be arranged from leaf to root.
- Returns
- A reference to this object.
bool HPS::KeyPath::operator== | ( | KeyPath const & | in_that | ) | const |
void HPS::KeyPath::Set | ( | KeyPath const & | in_that | ) |
Copies the supplied path into this object.
- Parameters
-
in_that The source of the copy.
KeyPath& HPS::KeyPath::SetKeys | ( | KeyArray const & | in_keys | ) |
Copies an array of keys into this object.
- Parameters
-
in_keys The source array, assumed to be arranged from leaf to root.
- Returns
- A reference to this object.
Copies an array of keys into this object.
- Parameters
-
in_key_count the number of keys in the array. in_keys The source array, assumed to arranged from leaf to root.
- Returns
- A reference to this object.
bool HPS::KeyPath::ShowEffectiveGlyphDefinition | ( | char const * | in_name, |
GlyphDefinition & | out_def | ||
) | const |
Shows the effective glyph definition belonging to the input name along this key path.
- Parameters
-
in_name UTF8-encoded name of the glyph to find along this key path. out_def The effective glyph definition, if any, with the specified name along this key path.
- Returns
- true if the glyph definition exists along this path, false otherwise.
bool HPS::KeyPath::ShowEffectiveImageDefinition | ( | char const * | in_name, |
ImageDefinition & | out_def | ||
) | const |
Shows the effective image definition belonging to the input name along this key path.
- Parameters
-
in_name UTF8-encoded name of the image to find along this key path. out_def The effective image definition, if any, with the specified name along this key path.
- Returns
- true if the image definition exists along this path, false otherwise.
bool HPS::KeyPath::ShowEffectiveLinePatternDefinition | ( | char const * | in_name, |
LinePatternDefinition & | out_def | ||
) | const |
Shows the effective line pattern definition belonging to the input name along this key path.
- Parameters
-
in_name UTF8-encoded name of the line pattern to find along this key path. out_def The effective material line pattern, if any, with the specified name along this key path.
- Returns
- true if the line pattern definition exists along this path, false otherwise.
bool HPS::KeyPath::ShowEffectiveMaterialPaletteDefinition | ( | char const * | in_name, |
MaterialPaletteDefinition & | out_def | ||
) | const |
Shows the effective material palette definition belonging to the input name along this key path.
- Parameters
-
in_name UTF8-encoded name of the material palette to find along this key path. out_def The effective material palette definition, if any, with the specified name along this key path.
- Returns
- true if the material palette definition exists along this path, false otherwise.
bool HPS::KeyPath::ShowEffectiveShaderDefinition | ( | char const * | in_name, |
ShaderDefinition & | out_def | ||
) | const |
Shows the effective shader definition belonging to the input name along this key path.
- Parameters
-
in_name UTF8-encoded name of the shader to find along this key path. out_def The effective shader definition, if any, with the specified name along this key path.
- Returns
- true if the shader definition exists along this path, false otherwise.
bool HPS::KeyPath::ShowEffectiveTextureDefinition | ( | char const * | in_name, |
TextureDefinition & | out_def | ||
) | const |
Shows the effective texture definition belonging to the input name along this key path.
- Parameters
-
in_name UTF8-encoded name of the texture to find along this key path. out_def The effective texture definition, if any, with the specified name along this key path.
- Returns
- true if the texture definition exists along this path, false otherwise.
bool HPS::KeyPath::ShowKeys | ( | KeyArray & | out_keys | ) | const |
Shows the keys defining this key path.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::KeyPath::ShowNetAttributeLock | ( | AttributeLockKit & | out_kit | ) | const |
Shows the net attribute lock settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetBounding | ( | BoundingKit & | out_kit | ) | const |
Shows the net bounding along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetCamera | ( | CameraKit & | out_kit | ) | const |
Shows the net camera attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetClipRegions | ( | PointArrayArrayArray & | out_loops_array, |
ClipSpaceArray & | out_spaces, | ||
ClipOperationArray & | out_operations, | ||
MatrixKitArray & | out_matrices | ||
) | const |
Collects all clip regions on key path.
- Parameters
-
out_loops_array An array of arrays of loops describing the clip region. out_spaces An array of the coordinate spaces in which loops are described. out_operations An array of the operations performed by the clip regions. out_matrices An array of the matrices used by the clip regions if they are in ClipSpace::Object else identity matrix.
- Returns
- true if clip regions exist along this path, false otherwise.
bool HPS::KeyPath::ShowNetColorInterpolation | ( | ColorInterpolationKit & | out_kit | ) | const |
Shows the net color interpolation attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetConditions | ( | UTF8Array & | out_conditions | ) | const |
Shows the net condition settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetContourLine | ( | ContourLineKit & | out_kit | ) | const |
Shows the net contour line attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetCulling | ( | CullingKit & | out_kit | ) | const |
Shows the net culling attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetCurveAttribute | ( | CurveAttributeKit & | out_kit | ) | const |
Shows the net curve attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetCuttingSectionAttribute | ( | CuttingSectionAttributeKit & | out_kit | ) | const |
Shows the net cutting section attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetCylinderAttribute | ( | CylinderAttributeKit & | out_kit | ) | const |
Shows the net cylinder attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetDrawingAttribute | ( | DrawingAttributeKit & | out_kit | ) | const |
Shows the net drawing attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetEdgeAttribute | ( | EdgeAttributeKit & | out_kit | ) | const |
Shows the net edge attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetHiddenLineAttribute | ( | HiddenLineAttributeKit & | out_kit | ) | const |
Shows the net hidden line attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetLightingAttribute | ( | LightingAttributeKit & | out_kit | ) | const |
Shows the net lighting attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetLineAttribute | ( | LineAttributeKit & | out_kit | ) | const |
Shows the net line attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetMarkerAttribute | ( | MarkerAttributeKit & | out_kit | ) | const |
Shows the net marker attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetMaterialMapping | ( | MaterialMappingKit & | out_kit | ) | const |
Shows the net material mapping attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetMaterialPalette | ( | UTF8 & | out_name | ) | const |
Shows the material palette name along this key path.
- Returns
- true if a material palette is set along this path, false otherwise.
bool HPS::KeyPath::ShowNetModellingMatrix | ( | MatrixKit & | out_kit | ) | const |
Shows the net modelling matrix attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetNURBSSurfaceAttribute | ( | NURBSSurfaceAttributeKit & | out_kit | ) | const |
Shows the net NURBS surface attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetPerformance | ( | PerformanceKit & | out_kit | ) | const |
Shows the net performance attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetSelectability | ( | SelectabilityKit & | out_kit | ) | const |
Shows the net selectability attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetSphereAttribute | ( | SphereAttributeKit & | out_kit | ) | const |
Shows the net sphere attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetSubwindow | ( | SubwindowKit & | out_kit | ) | const |
Shows the net subwindow attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetTextAttribute | ( | TextAttributeKit & | out_kit | ) | const |
Shows the net text attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetTextureMatrix | ( | MatrixKit & | out_kit | ) | const |
Shows the net texture matrix attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetTransformMask | ( | TransformMaskKit & | out_kit | ) | const |
Shows the net transform mask attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetTransparency | ( | TransparencyKit & | out_kit | ) | const |
Shows the net transparency attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetVisibility | ( | VisibilityKit & | out_kit | ) | const |
Shows the net visibility attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
bool HPS::KeyPath::ShowNetVisualEffects | ( | VisualEffectsKit & | out_kit | ) | const |
Shows the net visual effects attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
KeyPath& HPS::KeyPath::UnsetKeys | ( | ) |
Removes the keys defining this key path.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- include/hps.h