REFERENCE MANUAL
The KeyPath contains an array of keys, organized from leaf to root. More...
Public Member Functions | |
HPS.KeyPath | Append (HPS.Key in_key) |
Appends the supplied Key into this object. More... | |
HPS.KeyPath | Append (HPS.KeyPath in_key_path) |
Appends the supplied key into this object. More... | |
HPS.KeyPath | Append (HPS.Key[] in_key_array) |
Appends the supplied key into this object. More... | |
bool | ComputeTextExtent (string in_text, out float out_xfrac, out float out_yfrac) |
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. More... | |
bool | ComputeTransform (HPS.Coordinate.Space in_space, HPS.Coordinate.Space in_output_space, out HPS.MatrixKit out_matrix) |
Computes the matrix which transforms objects from the input space to the output space along this key path. More... | |
bool | ConvertCoordinate (HPS.Coordinate.Space in_space, HPS.Point in_point, HPS.Coordinate.Space in_output_space, out HPS.Point out_point) |
Converts a point from one coordinate space to another using the transforms along this key path. More... | |
bool | ConvertCoordinate (HPS.Coordinate.Space in_space, HPS.Point[] in_points, HPS.Coordinate.Space in_output_space, out HPS.Point[] out_points) |
Converts a point from one coordinate space to another using the transforms along this key path. More... | |
override void | Dispose () |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.KeyPath in_that) |
Check if the source KeyPath is equivalent to this object. More... | |
ulong | GatherCutGeometry (HPS.SegmentKey in_destination, HPS.CutGeometryGatheringOptionsKit in_options) |
Collects capping geometry generated by cutting planes. More... | |
override int | GetHashCode () |
KeyPath () | |
Creates an uninitialized key path that refers to no database objects. More... | |
KeyPath (HPS.Key[] in_path) | |
Creates a new KeyPath object based on the supplied path. More... | |
KeyPath (HPS.KeyPath in_that) | |
Copies in_that into this key path. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.KeyPath in_that) |
Copies the supplied path into this object. More... | |
HPS.KeyPath | SetKeys (HPS.Key[] in_keys) |
Copies an array of keys into this object. More... | |
bool | ShowKeys (out HPS.Key[] out_keys) |
Shows the keys defining this key path. More... | |
bool | ShowNetAttributeLocks (out HPS.AttributeLockKit out_kit) |
Shows the net attribute lock settings along this key path. More... | |
bool | ShowNetBounding (out HPS.BoundingKit out_kit) |
Shows the net bounding along this key path. More... | |
bool | ShowNetCamera (out HPS.CameraKit out_kit) |
Shows the net camera attribute settings along this key path. More... | |
bool | ShowNetColorInterpolation (out HPS.ColorInterpolationKit out_kit) |
Shows the net color interpolation attribute settings along this key path. More... | |
bool | ShowNetConditions (out string[] out_conditions) |
Shows the net condition settings along this key path. More... | |
bool | ShowNetContourLine (out HPS.ContourLineKit out_kit) |
Shows the net contour line attribute settings along this key path. More... | |
bool | ShowNetCulling (out HPS.CullingKit out_kit) |
Shows the net culling attribute settings along this key path. More... | |
bool | ShowNetCurveAttributes (out HPS.CurveAttributeKit out_kit) |
Shows the net curve attribute settings along this key path. More... | |
bool | ShowNetCuttingSectionAttributes (out HPS.CuttingSectionAttributeKit out_kit) |
Shows the net cutting section attribute settings along this key path. More... | |
bool | ShowNetCylinderAttributes (out HPS.CylinderAttributeKit out_kit) |
Shows the net cylinder attribute settings along this key path. More... | |
bool | ShowNetDrawingAttribute (out HPS.DrawingAttributeKit out_kit) |
Shows the net drawing attribute settings along this key path. More... | |
bool | ShowNetEdgeAttributes (out HPS.EdgeAttributeKit out_kit) |
Shows the net edge attribute settings along this key path. More... | |
bool | ShowNetHiddenLineAttribute (out HPS.HiddenLineAttributeKit out_kit) |
Shows the net hidden line attribute settings along this key path. More... | |
bool | ShowNetLightingAttributes (out HPS.LightingAttributeKit out_kit) |
Shows the net lighting attribute settings along this key path. More... | |
bool | ShowNetLineAttributes (out HPS.LineAttributeKit out_kit) |
Shows the net line attribute settings along this key path. More... | |
bool | ShowNetMarkerAttributes (out HPS.MarkerAttributeKit out_kit) |
Shows the net marker attribute settings along this key path. More... | |
bool | ShowNetMaterialMapping (out HPS.MaterialMappingKit out_kit) |
Shows the net material mapping attribute settings along this key path. More... | |
bool | ShowNetModellingMatrix (out HPS.MatrixKit out_kit) |
Shows the net modelling matrix attribute settings along this key path. More... | |
bool | ShowNetNURBSSurfaceAttributes (out HPS.NURBSSurfaceAttributeKit out_kit) |
Shows the net NURBS surface attribute settings along this key path. More... | |
bool | ShowNetPerformance (out HPS.PerformanceKit out_kit) |
Shows the net performance attribute settings along this key path. More... | |
bool | ShowNetSelectability (out HPS.SelectabilityKit out_kit) |
Shows the net selectability attribute settings along this key path. More... | |
bool | ShowNetSphereAttributes (out HPS.SphereAttributeKit out_kit) |
Shows the net sphere attribute settings along this key path. More... | |
bool | ShowNetSubwindow (out HPS.SubwindowKit out_kit) |
Shows the net subwindow attribute settings along this key path. More... | |
bool | ShowNetTextAttributes (out HPS.TextAttributeKit out_kit) |
Shows the net text attribute settings along this key path. More... | |
bool | ShowNetTextureMatrix (out HPS.MatrixKit out_kit) |
Shows the net texture matrix attribute settings along this key path. More... | |
bool | ShowNetTransformMask (out HPS.TransformMaskKit out_kit) |
Shows the net transform mask attribute settings along this key path. More... | |
bool | ShowNetTransparency (out HPS.TransparencyKit out_kit) |
Shows the net transparency attribute settings along this key path. More... | |
bool | ShowNetVisibility (out HPS.VisibilityKit out_kit) |
Shows the net visibility attribute settings along this key path. More... | |
bool | ShowNetVisualEffects (out HPS.VisualEffectsKit out_kit) |
Shows the net visual effects attribute settings along this key path. More... | |
HPS.KeyPath | UnsetKeys () |
Removes the keys defining this key path. More... | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.KeyPath a, HPS.KeyPath b) |
static bool | operator== (HPS.KeyPath a, HPS.KeyPath b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
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 | ( | HPS.Key[] | 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 | ( | HPS.KeyPath | in_that | ) |
Copies in_that into this key path.
HPS.KeyPath HPS.KeyPath.Append | ( | HPS.Key | in_key | ) |
HPS.KeyPath HPS.KeyPath.Append | ( | HPS.KeyPath | in_key_path | ) |
Appends the supplied key into this object.
Same as operator+= function.
in_key_path | The <ref refid="class_h_p_s_1_1_key_path" kindref="compound">KeyPath</ref> to be appended to this. |
HPS.KeyPath HPS.KeyPath.Append | ( | HPS.Key[] | 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 | ( | string | in_text, |
out float | out_xfrac, | ||
out float | out_yfrac | ||
) |
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 | ( | HPS.Coordinate.Space | in_space, |
HPS.Coordinate.Space | in_output_space, | ||
out HPS.MatrixKit | out_matrix | ||
) |
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 | ( | HPS.Coordinate.Space | in_space, |
HPS.Point | in_point, | ||
HPS.Coordinate.Space | in_output_space, | ||
out HPS.Point | out_point | ||
) |
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 | ( | HPS.Coordinate.Space | in_space, |
HPS.Point[] | in_points, | ||
HPS.Coordinate.Space | in_output_space, | ||
out HPS.Point[] | out_points | ||
) |
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 | ( | HPS.KeyPath | in_that | ) |
Check if the source KeyPath is equivalent to this object.
ulong HPS.KeyPath.GatherCutGeometry | ( | HPS.SegmentKey | in_destination, |
HPS.CutGeometryGatheringOptionsKit | in_options | ||
) |
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. |
|
virtual |
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.
void HPS.KeyPath.Set | ( | HPS.KeyPath | in_that | ) |
Copies the supplied path into this object.
in_that | The source of the copy. |
HPS.KeyPath HPS.KeyPath.SetKeys | ( | HPS.Key[] | in_keys | ) |
Copies an array of keys into this object.
in_keys | The source array, assumed to be arranged from leaf to root. |
bool HPS.KeyPath.ShowKeys | ( | out HPS.Key[] | out_keys | ) |
Shows the keys defining this key path.
bool HPS.KeyPath.ShowNetAttributeLocks | ( | out HPS.AttributeLockKit | out_kit | ) |
Shows the net attribute lock settings along this key path.
bool HPS.KeyPath.ShowNetBounding | ( | out HPS.BoundingKit | out_kit | ) |
Shows the net bounding along this key path.
bool HPS.KeyPath.ShowNetCamera | ( | out HPS.CameraKit | out_kit | ) |
Shows the net camera attribute settings along this key path.
bool HPS.KeyPath.ShowNetColorInterpolation | ( | out HPS.ColorInterpolationKit | out_kit | ) |
Shows the net color interpolation attribute settings along this key path.
bool HPS.KeyPath.ShowNetConditions | ( | out string[] | out_conditions | ) |
Shows the net condition settings along this key path.
bool HPS.KeyPath.ShowNetContourLine | ( | out HPS.ContourLineKit | out_kit | ) |
Shows the net contour line attribute settings along this key path.
bool HPS.KeyPath.ShowNetCulling | ( | out HPS.CullingKit | out_kit | ) |
Shows the net culling attribute settings along this key path.
bool HPS.KeyPath.ShowNetCurveAttributes | ( | out HPS.CurveAttributeKit | out_kit | ) |
Shows the net curve attribute settings along this key path.
bool HPS.KeyPath.ShowNetCuttingSectionAttributes | ( | out HPS.CuttingSectionAttributeKit | out_kit | ) |
Shows the net cutting section attribute settings along this key path.
bool HPS.KeyPath.ShowNetCylinderAttributes | ( | out HPS.CylinderAttributeKit | out_kit | ) |
Shows the net cylinder attribute settings along this key path.
bool HPS.KeyPath.ShowNetDrawingAttribute | ( | out HPS.DrawingAttributeKit | out_kit | ) |
Shows the net drawing attribute settings along this key path.
bool HPS.KeyPath.ShowNetEdgeAttributes | ( | out HPS.EdgeAttributeKit | out_kit | ) |
Shows the net edge attribute settings along this key path.
bool HPS.KeyPath.ShowNetHiddenLineAttribute | ( | out HPS.HiddenLineAttributeKit | out_kit | ) |
Shows the net hidden line attribute settings along this key path.
bool HPS.KeyPath.ShowNetLightingAttributes | ( | out HPS.LightingAttributeKit | out_kit | ) |
Shows the net lighting attribute settings along this key path.
bool HPS.KeyPath.ShowNetLineAttributes | ( | out HPS.LineAttributeKit | out_kit | ) |
Shows the net line attribute settings along this key path.
bool HPS.KeyPath.ShowNetMarkerAttributes | ( | out HPS.MarkerAttributeKit | out_kit | ) |
Shows the net marker attribute settings along this key path.
bool HPS.KeyPath.ShowNetMaterialMapping | ( | out HPS.MaterialMappingKit | out_kit | ) |
Shows the net material mapping attribute settings along this key path.
bool HPS.KeyPath.ShowNetModellingMatrix | ( | out HPS.MatrixKit | out_kit | ) |
Shows the net modelling matrix attribute settings along this key path.
bool HPS.KeyPath.ShowNetNURBSSurfaceAttributes | ( | out HPS.NURBSSurfaceAttributeKit | out_kit | ) |
Shows the net NURBS surface attribute settings along this key path.
bool HPS.KeyPath.ShowNetPerformance | ( | out HPS.PerformanceKit | out_kit | ) |
Shows the net performance attribute settings along this key path.
bool HPS.KeyPath.ShowNetSelectability | ( | out HPS.SelectabilityKit | out_kit | ) |
Shows the net selectability attribute settings along this key path.
bool HPS.KeyPath.ShowNetSphereAttributes | ( | out HPS.SphereAttributeKit | out_kit | ) |
Shows the net sphere attribute settings along this key path.
bool HPS.KeyPath.ShowNetSubwindow | ( | out HPS.SubwindowKit | out_kit | ) |
Shows the net subwindow attribute settings along this key path.
bool HPS.KeyPath.ShowNetTextAttributes | ( | out HPS.TextAttributeKit | out_kit | ) |
Shows the net text attribute settings along this key path.
bool HPS.KeyPath.ShowNetTextureMatrix | ( | out HPS.MatrixKit | out_kit | ) |
Shows the net texture matrix attribute settings along this key path.
bool HPS.KeyPath.ShowNetTransformMask | ( | out HPS.TransformMaskKit | out_kit | ) |
Shows the net transform mask attribute settings along this key path.
bool HPS.KeyPath.ShowNetTransparency | ( | out HPS.TransparencyKit | out_kit | ) |
Shows the net transparency attribute settings along this key path.
bool HPS.KeyPath.ShowNetVisibility | ( | out HPS.VisibilityKit | out_kit | ) |
Shows the net visibility attribute settings along this key path.
bool HPS.KeyPath.ShowNetVisualEffects | ( | out HPS.VisualEffectsKit | out_kit | ) |
Shows the net visual effects attribute settings along this key path.
HPS.KeyPath HPS.KeyPath.UnsetKeys | ( | ) |
Removes the keys defining this key path.