#include <hps.h>
Public Member Functions | |
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) | |
KeyPath & | operator= (KeyPath &&in_that) |
virtual | ~KeyPath () |
HPS::Type | ObjectType () const |
KeyPath & | operator+= (Key const &in_key) |
KeyPath & | operator+= (KeyPath const &in_key_path) |
KeyPath & | operator+= (KeyArray const &in_key_array) |
KeyPath & | Append (Key const &in_key) |
KeyPath & | Append (KeyPath const &in_key_path) |
KeyPath & | Append (KeyArray const &in_key_array) |
KeyPath & | operator= (KeyPath const &in_that) |
KeyPath & | operator= (KeyArray const &in_path) |
void | Set (KeyPath const &in_that) |
bool | Equals (KeyPath const &in_that) const |
bool | operator!= (KeyPath const &in_that) const |
bool | operator== (KeyPath const &in_that) const |
KeyPath & | SetKeys (KeyArray const &in_keys) |
KeyPath & | SetKeys (size_t in_key_count, Key const in_keys[]) |
KeyPath & | UnsetKeys () |
bool | ShowKeys (KeyArray &out_keys) 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 | 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 | ShowNetVisibility (VisibilityKit &out_kit) const |
bool | ShowNetBounding (BoundingKit &out_kit) const |
bool | ShowNetCamera (CameraKit &out_kit) const |
bool | ShowNetColorInterpolation (ColorInterpolationKit &out_kit) const |
bool | ShowNetContourLine (ContourLineKit &out_kit) const |
bool | ShowNetPerformance (PerformanceKit &out_kit) const |
bool | ShowNetHiddenLineAttribute (HiddenLineAttributeKit &out_kit) const |
bool | ShowNetDrawingAttribute (DrawingAttributeKit &out_kit) const |
bool | ShowNetSelectability (SelectabilityKit &out_kit) const |
bool | ShowNetMarkerAttributes (MarkerAttributeKit &out_kit) const |
bool | ShowNetSphereAttributes (SphereAttributeKit &out_kit) const |
bool | ShowNetLightingAttributes (LightingAttributeKit &out_kit) const |
bool | ShowNetCylinderAttributes (CylinderAttributeKit &out_kit) const |
bool | ShowNetCuttingSectionAttributes (CuttingSectionAttributeKit &out_kit) const |
bool | ShowNetTextAttributes (TextAttributeKit &out_kit) const |
bool | ShowNetLineAttributes (LineAttributeKit &out_kit) const |
bool | ShowNetEdgeAttributes (EdgeAttributeKit &out_kit) const |
bool | ShowNetCurveAttributes (CurveAttributeKit &out_kit) const |
bool | ShowNetModellingMatrix (MatrixKit &out_kit) const |
bool | ShowNetTextureMatrix (MatrixKit &out_kit) const |
bool | ShowNetCulling (CullingKit &out_kit) const |
bool | ShowNetTransparency (TransparencyKit &out_kit) const |
bool | ShowNetTransformMask (TransformMaskKit &out_kit) const |
bool | ShowNetMaterialMapping (MaterialMappingKit &out_kit) const |
bool | ShowNetNURBSSurfaceAttributes (NURBSSurfaceAttributeKit &out_kit) const |
bool | ShowNetVisualEffects (VisualEffectsKit &out_kit) const |
bool | ShowNetSubwindow (SubwindowKit &out_kit) const |
bool | ShowNetAttributeLocks (AttributeLockKit &out_kit) const |
bool | ShowNetConditions (UTF8Array &out_conditions) const |
size_t | GatherCutGeometry (SegmentKey const &in_destination, CutGeometryGatheringOptionsKit const &in_options) const |
bool | ShowNetMaterialPalette (UTF8 &out_name) const |
bool | ShowEffectiveMaterialPaletteDefinition (char const *in_name, MaterialPaletteDefinition &out_def) const |
bool | ShowEffectiveGlyphDefinition (char const *in_name, GlyphDefinition &out_def) const |
bool | ShowEffectiveLinePatternDefinition (char const *in_name, LinePatternDefinition &out_def) const |
bool | ShowEffectiveShaderDefinition (char const *in_name, ShaderDefinition &out_def) const |
bool | ShowEffectiveTextureDefinition (char const *in_name, TextureDefinition &out_def) const |
bool | ShowEffectiveImageDefinition (char const *in_name, ImageDefinition &out_def) const |
![]() | |
Object (Object const &that) | |
Object & | operator= (Object const &other_object) |
Object (Object &&in_that) | |
Object & | operator= (Object &&in_that) |
HPS::Type | Type () const |
virtual bool | Empty () const |
virtual void | Reset () |
bool | HasType (HPS::Type in_mask) const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
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.
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.
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.
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.
Appends the supplied key into this object. Same as operator+= function.
in_key_path | The KeyPath to be appended to this. |
KeyPath& HPS::KeyPath::Append | ( | KeyArray const & | in_key_array | ) |
Appends the supplied key into this object. Same as operator+= function.
in_key_array | The KeyArray to be appended to this. |
bool HPS::KeyPath::ComputeTextExtent | ( | char const * | in_text, |
float & | out_xfrac, | ||
float & | out_yfrac | ||
) | const |
Computes the text extent of the objects as a fraction of the segment window from 0.0 to 1.0 (or more) along this key path.
in_text | The text to measure along this keypath |
out_xfrac | The width fraction of the text extent |
out_yfrac | The height fraction of the text extent |
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.
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. |
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.
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. |
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.
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. |
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.
in_destination | A segment that the capping geometry will be deposited into. |
in_options | Options for the gathering operation. |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS::Object.
bool HPS::KeyPath::operator!= | ( | KeyPath const & | in_that | ) | const |
Appends the supplied Key into this object. Same as Append function.
in_key | The key to be appended to this. |
KeyPath& HPS::KeyPath::operator+= | ( | KeyArray const & | in_key_array | ) |
Appends the supplied KeyArray into this object. Same as Append function.
in_key_array | The KeyArray to be appended to this. |
Copies the supplied path into this object.
in_that | The source of the copy. |
KeyPath& HPS::KeyPath::operator= | ( | KeyArray const & | in_path | ) |
Copies an array of keys into this object.
in_path | The source array, assumed to be arranged from leaf to root. |
bool HPS::KeyPath::operator== | ( | KeyPath const & | in_that | ) | const |
void HPS::KeyPath::Set | ( | KeyPath const & | in_that | ) |
Copies the supplied path into this object.
in_that | The source of the copy. |
KeyPath& HPS::KeyPath::SetKeys | ( | KeyArray const & | in_keys | ) |
Copies an array of keys into this object.
in_keys | The source array, assumed to be arranged from leaf to root. |
Copies an array of keys into this object.
in_key_count | the number of keys in the array. |
in_keys | The source array, assumed to arranged from leaf to root. |
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.
in_name | UTF8-encoded name of the glyph to find along this key path. |
out_found | The effective glyph definition, if any, with the specified name along this key path. |
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.
in_name | UTF8-encoded name of the image to find along this key path. |
out_found | The effective image definition, if any, with the specified name along this key path. |
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.
in_name | UTF8-encoded name of the line pattern to find along this key path. |
out_found | The effective material line pattern, if any, with the specified name along this key path. |
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.
in_name | UTF8-encoded name of the material palette to find along this key path. |
out_found | The effective material palette definition, if any, with the specified name along this key path. |
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.
in_name | UTF8-encoded name of the shader to find along this key path. |
out_found | The effective shader definition, if any, with the specified name along this key path. |
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.
in_name | UTF8-encoded name of the texture to find along this key path. |
out_found | The effective texture definition, if any, with the specified name along this key path. |
bool HPS::KeyPath::ShowKeys | ( | KeyArray & | out_keys | ) | const |
Shows the keys defining this key path.
bool HPS::KeyPath::ShowNetAttributeLocks | ( | AttributeLockKit & | out_kit | ) | const |
Shows the net attribute lock settings along this key path.
bool HPS::KeyPath::ShowNetBounding | ( | BoundingKit & | out_kit | ) | const |
Shows the net bounding along this key path.
bool HPS::KeyPath::ShowNetCamera | ( | CameraKit & | out_kit | ) | const |
Shows the net camera attribute settings along this key path.
bool HPS::KeyPath::ShowNetColorInterpolation | ( | ColorInterpolationKit & | out_kit | ) | const |
Shows the net color interpolation attribute settings along this key path.
bool HPS::KeyPath::ShowNetConditions | ( | UTF8Array & | out_conditions | ) | const |
Shows the net condition settings along this key path.
bool HPS::KeyPath::ShowNetContourLine | ( | ContourLineKit & | out_kit | ) | const |
Shows the net contour line attribute settings along this key path.
bool HPS::KeyPath::ShowNetCulling | ( | CullingKit & | out_kit | ) | const |
Shows the net culling attribute settings along this key path.
bool HPS::KeyPath::ShowNetCurveAttributes | ( | CurveAttributeKit & | out_kit | ) | const |
Shows the net curve attribute settings along this key path.
bool HPS::KeyPath::ShowNetCuttingSectionAttributes | ( | CuttingSectionAttributeKit & | out_kit | ) | const |
Shows the net cutting section attribute settings along this key path.
bool HPS::KeyPath::ShowNetCylinderAttributes | ( | CylinderAttributeKit & | out_kit | ) | const |
Shows the net cylinder attribute settings along this key path.
bool HPS::KeyPath::ShowNetDrawingAttribute | ( | DrawingAttributeKit & | out_kit | ) | const |
Shows the net drawing attribute settings along this key path.
bool HPS::KeyPath::ShowNetEdgeAttributes | ( | EdgeAttributeKit & | out_kit | ) | const |
Shows the net edge attribute settings along this key path.
bool HPS::KeyPath::ShowNetHiddenLineAttribute | ( | HiddenLineAttributeKit & | out_kit | ) | const |
Shows the net hidden line attribute settings along this key path.
bool HPS::KeyPath::ShowNetLightingAttributes | ( | LightingAttributeKit & | out_kit | ) | const |
Shows the net lighting attribute settings along this key path.
bool HPS::KeyPath::ShowNetLineAttributes | ( | LineAttributeKit & | out_kit | ) | const |
Shows the net line attribute settings along this key path.
bool HPS::KeyPath::ShowNetMarkerAttributes | ( | MarkerAttributeKit & | out_kit | ) | const |
Shows the net marker attribute settings along this key path.
bool HPS::KeyPath::ShowNetMaterialMapping | ( | MaterialMappingKit & | out_kit | ) | const |
Shows the net material mapping attribute settings along this key path.
bool HPS::KeyPath::ShowNetMaterialPalette | ( | UTF8 & | out_name | ) | const |
Shows the material palette name along this key path.
bool HPS::KeyPath::ShowNetModellingMatrix | ( | MatrixKit & | out_kit | ) | const |
Shows the net modelling matrix attribute settings along this key path.
bool HPS::KeyPath::ShowNetNURBSSurfaceAttributes | ( | NURBSSurfaceAttributeKit & | out_kit | ) | const |
Shows the net NURBS surface attribute settings along this key path.
bool HPS::KeyPath::ShowNetPerformance | ( | PerformanceKit & | out_kit | ) | const |
Shows the net performance attribute settings along this key path.
bool HPS::KeyPath::ShowNetSelectability | ( | SelectabilityKit & | out_kit | ) | const |
Shows the net selectability attribute settings along this key path.
bool HPS::KeyPath::ShowNetSphereAttributes | ( | SphereAttributeKit & | out_kit | ) | const |
Shows the net sphere attribute settings along this key path.
bool HPS::KeyPath::ShowNetSubwindow | ( | SubwindowKit & | out_kit | ) | const |
Shows the net subwindow attribute settings along this key path.
bool HPS::KeyPath::ShowNetTextAttributes | ( | TextAttributeKit & | out_kit | ) | const |
Shows the net text attribute settings along this key path.
bool HPS::KeyPath::ShowNetTextureMatrix | ( | MatrixKit & | out_kit | ) | const |
Shows the net texture matrix attribute settings along this key path.
bool HPS::KeyPath::ShowNetTransformMask | ( | TransformMaskKit & | out_kit | ) | const |
Shows the net transform mask attribute settings along this key path.
bool HPS::KeyPath::ShowNetTransparency | ( | TransparencyKit & | out_kit | ) | const |
Shows the net transparency attribute settings along this key path.
bool HPS::KeyPath::ShowNetVisibility | ( | VisibilityKit & | out_kit | ) | const |
Shows the net visibility attribute settings along this key path.
bool HPS::KeyPath::ShowNetVisualEffects | ( | VisualEffectsKit & | out_kit | ) | const |
Shows the net visual effects attribute settings along this key path.
KeyPath& HPS::KeyPath::UnsetKeys | ( | ) |
Removes the keys defining this key path.