< Home

< Table of Contents

REFERENCE MANUAL

KeyPath Class Reference

#include <hps.h>

Inheritance diagram for KeyPath:
Object

Public Member Functions

KeyPathAppend (Key const &in_key)
 
KeyPathAppend (KeyPath const &in_key_path)
 
KeyPathAppend (KeyArray const &in_key_array)
 
bool ComputeTextExtent (const char *in_text, float &out_xfrac, float &out_yfrac) const
 
bool ComputeTransform (Coordinate::Space in_space, Coordinate::Space in_output_space, 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)
 
Type ObjectType () const
 
bool operator!= (KeyPath const &in_that) const
 
KeyPathoperator+= (Key const &in_key)
 
KeyPathoperator+= (KeyPath const &in_key_path)
 
KeyPathoperator+= (KeyArray const &in_key_array)
 
KeyPathoperator= (KeyPath &&in_that)
 
KeyPathoperator= (KeyPath const &in_that)
 
KeyPathoperator= (KeyArray const &in_path)
 
bool operator== (KeyPath const &in_that) const
 
void Set (KeyPath const &in_that)
 
KeyPathSetKeys (KeyArray const &in_keys)
 
KeyPathSetKeys (size_t in_key_count, Key const in_keys[])
 
bool ShowKeys (KeyArray &out_keys) const
 
bool ShowNetAttributeLocks (AttributeLockKit &out_kit) const
 
bool ShowNetBounding (BoundingKit &out_kit) const
 
bool ShowNetCamera (CameraKit &out_kit) 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 ShowNetCurveAttributes (CurveAttributeKit &out_kit) const
 
bool ShowNetCuttingSectionAttributes (CuttingSectionAttributeKit &out_kit) const
 
bool ShowNetCylinderAttributes (CylinderAttributeKit &out_kit) const
 
bool ShowNetDrawingAttribute (DrawingAttributeKit &out_kit) const
 
bool ShowNetEdgeAttributes (EdgeAttributeKit &out_kit) const
 
bool ShowNetHiddenLineAttribute (HiddenLineAttributeKit &out_kit) const
 
bool ShowNetLightingAttributes (LightingAttributeKit &out_kit) const
 
bool ShowNetLineAttributes (LineAttributeKit &out_kit) const
 
bool ShowNetMarkerAttributes (MarkerAttributeKit &out_kit) const
 
bool ShowNetMaterialMapping (MaterialMappingKit &out_kit) const
 
bool ShowNetModellingMatrix (MatrixKit &out_kit) const
 
bool ShowNetNURBSSurfaceAttributes (NURBSSurfaceAttributeKit &out_kit) const
 
bool ShowNetPerformance (PerformanceKit &out_kit) const
 
bool ShowNetSelectability (SelectabilityKit &out_kit) const
 
bool ShowNetSphereAttributes (SphereAttributeKit &out_kit) const
 
bool ShowNetSubwindow (SubwindowKit &out_kit) const
 
bool ShowNetTextAttributes (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
 
KeyPathUnsetKeys ()
 
virtual ~KeyPath ()
 
- Public Member Functions inherited from Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (Type in_mask) const
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
Type Type () const
 

Additional Inherited Members

- Static Public Member Functions inherited from Object
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

KeyPath::KeyPath ( )

Creates an uninitialized key path that refers to no database objects.

KeyPath::KeyPath ( KeyArray const &  in_path)

Creates a new KeyPath object based on the supplied path.

Parameters
in_pathAn array of keys arranged from leaf to root.
KeyPath::KeyPath ( size_t  in_path_count,
Key const  in_path[] 
)

Creates a new KeyPath object based on the supplied path.

Parameters
in_path_countThe number of keys in the array.
in_pathAn array of keys arranged from leaf to root.
KeyPath::KeyPath ( KeyPath const &  in_that)

Copies in_that into this key path.

KeyPath::KeyPath ( KeyPath &&  in_that)

The move constructor creates a KeyPath by transferring the underlying impl of the rvalue reference to this KeyPath thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a KeyPath to take the impl from.
virtual KeyPath::~KeyPath ( )
virtual

Releases a reference to the database object this object is tied to.

Member Function Documentation

KeyPath& KeyPath::Append ( Key const &  in_key)

Appends the supplied Key into this object. Same as operator+= function.

Parameters
in_keyThe Key to be appended to this.
Returns
A reference to this object.
KeyPath& KeyPath::Append ( KeyPath const &  in_key_path)

Appends the supplied key into this object. Same as operator+= function.

Parameters
in_key_pathThe KeyPath to be appended to this.
Returns
A reference to this object.
KeyPath& KeyPath::Append ( KeyArray const &  in_key_array)

Appends the supplied key into this object. Same as operator+= function.

Parameters
in_key_arrayThe KeyArray to be appended to this.
Returns
A reference to this object.
bool KeyPath::ComputeTextExtent ( const char *  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.

Parameters
in_textThe text to measure along this keypath
out_xfracThe width fraction of the text extent
out_yfracThe height fraction of the text extent
Returns
true if the operation succeeded, false otherwise.
bool KeyPath::ComputeTransform ( Coordinate::Space  in_space,
Coordinate::Space  in_output_space,
MatrixKit out_matrix 
) const

Computes the matrix which transforms objects from the input space to the output space along this key path.

Parameters
in_spaceThe starting or input coordinate space.
in_output_spaceThe final or output coordinate space.
out_matrixThe matrix which transforms objects from the input space to the output space.
Returns
true if the operation succeeded, false otherwise.
bool 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_spaceThe coordinate space of the input point.
in_pointThe input point to convert.
in_output_spaceThe coordinate space to convert the input point into.
out_pointThe output point, after conversion.
Returns
true if the operation succeeded, false otherwise.
bool 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_spaceThe coordinate space of the input point.
in_pointsThe input points to convert.
in_output_spaceThe coordinate space to convert the input point into.
out_pointsThe output points, after conversion.
Returns
true if the operation succeeded, false otherwise.
bool KeyPath::Equals ( KeyPath const &  in_that) const

Check if the source KeyPath is equivalent to this object.

Parameters
in_kitThe source KeyPath to compare to this object.
Returns
true if the objects are equivalent, false otherwise.
size_t 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_destinationA segment that the capping geometry will be deposited into.
in_optionsOptions for the gathering operation.
Returns
The number of individual caps created.
Type KeyPath::ObjectType ( ) const
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 Object.

bool KeyPath::operator!= ( KeyPath const &  in_that) const

Check if the source KeyPath is not equivalent to this object.

Parameters
in_kitThe source KeyPath to compare to this object.
Returns
true if the objects are not equivalent, false otherwise.
KeyPath& KeyPath::operator+= ( Key const &  in_key)

Appends the supplied Key into this object. Same as Append function.

Parameters
in_keyThe key to be appended to this.
Returns
A reference to this object.
KeyPath& KeyPath::operator+= ( KeyPath const &  in_key_path)

Appends the supplied KeyPath into this object. Same as Append function.

Parameters
in_key_pathThe KeyPath to be appended to this.
Returns
A reference to this object.
KeyPath& KeyPath::operator+= ( KeyArray const &  in_key_array)

Appends the supplied KeyArray into this object. Same as Append function.

Parameters
in_key_arrayThe KeyArray to be appended to this.
Returns
A reference to this object.
KeyPath& KeyPath::operator= ( KeyPath &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this KeyPath thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a KeyPath to take the impl from.
Returns
A reference to this KeyPath.
KeyPath& KeyPath::operator= ( KeyPath const &  in_that)

Copies the supplied path into this object.

Parameters
in_thatThe source of the copy.
Returns
A reference to this object.
KeyPath& KeyPath::operator= ( KeyArray const &  in_path)

Copies an array of keys into this object.

Parameters
in_pathThe source array, assumed to be arranged from leaf to root.
Returns
A reference to this object.
bool KeyPath::operator== ( KeyPath const &  in_that) const

Check if the source KeyPath is equivalent to this object.

Parameters
in_kitThe source KeyPath to compare to this object.
Returns
true if the objects are equivalent, false otherwise.
void KeyPath::Set ( KeyPath const &  in_that)

Copies the supplied path into this object.

Parameters
in_thatThe source of the copy.
KeyPath& KeyPath::SetKeys ( KeyArray const &  in_keys)

Copies an array of keys into this object.

Parameters
in_keysThe source array, assumed to be arranged from leaf to root.
Returns
A reference to this object.
KeyPath& KeyPath::SetKeys ( size_t  in_key_count,
Key const  in_keys[] 
)

Copies an array of keys into this object.

Parameters
in_key_countthe number of keys in the array.
in_keysThe source array, assumed to arranged from leaf to root.
Returns
A reference to this object.
bool KeyPath::ShowKeys ( KeyArray &  out_keys) const

Shows the keys defining this key path.

Returns
true if the setting is valid, false otherwise.
bool KeyPath::ShowNetAttributeLocks ( 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 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 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 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 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 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 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 KeyPath::ShowNetCurveAttributes ( 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 KeyPath::ShowNetCuttingSectionAttributes ( 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 KeyPath::ShowNetCylinderAttributes ( 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 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 KeyPath::ShowNetEdgeAttributes ( 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 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 KeyPath::ShowNetLightingAttributes ( 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 KeyPath::ShowNetLineAttributes ( 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 KeyPath::ShowNetMarkerAttributes ( 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 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 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 KeyPath::ShowNetNURBSSurfaceAttributes ( 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 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 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 KeyPath::ShowNetSphereAttributes ( 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 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 KeyPath::ShowNetTextAttributes ( 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 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 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 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 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 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& 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: