
Public Member Functions | |
HPS.KeyPath | Append (HPS.Key in_key) |
Appends the supplied Key into this object. Same as operator+= function. More... | |
HPS.KeyPath | Append (HPS.KeyPath in_key_path) |
Appends the supplied key into this object. Same as operator+= function. More... | |
HPS.KeyPath | Append (HPS.Key[] in_key_array) |
Appends the supplied key into this object. Same as operator+= function. More... | |
bool | ComputeExtent (out HPS.Rectangle out_extent) |
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. More... | |
bool | ComputeExtent (HPS.VisibilityKit in_vis, out HPS.Rectangle out_extent) |
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. More... | |
bool | ComputeExtent (HPS.Extent.ClipRegion in_clip, out HPS.Rectangle out_extent) |
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. More... | |
bool | ComputeExtent (HPS.VisibilityKit in_vis, HPS.Extent.ClipRegion in_clip, out HPS.Rectangle out_extent) |
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. More... | |
bool | ComputeTextExtent (string in_text, out float out_xfrac, out float out_yfrac) |
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. 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. 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. 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. This does not necessarily give the true type of the underlying object. 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 | ShowEffectiveGlyphDefinition (string in_name, out HPS.GlyphDefinition out_def) |
Shows the effective glyph definition belonging to the input name along this key path. More... | |
bool | ShowEffectiveImageDefinition (string in_name, out HPS.ImageDefinition out_def) |
Shows the effective image definition belonging to the input name along this key path. More... | |
bool | ShowEffectiveLinePatternDefinition (string in_name, out HPS.LinePatternDefinition out_def) |
Shows the effective line pattern definition belonging to the input name along this key path. More... | |
bool | ShowEffectiveMaterialPaletteDefinition (string in_name, out HPS.MaterialPaletteDefinition out_def) |
Shows the effective material palette definition belonging to the input name along this key path. More... | |
bool | ShowEffectiveShaderDefinition (string in_name, out HPS.ShaderDefinition out_def) |
Shows the effective shader definition belonging to the input name along this key path. More... | |
bool | ShowEffectiveTextureDefinition (string in_name, out HPS.TextureDefinition out_def) |
Shows the effective texture definition belonging to the input name along this key path. More... | |
bool | ShowKeys (out HPS.Key[] out_keys) |
Shows the keys defining this key path. More... | |
bool | ShowNetAttributeLock (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 | ShowNetClipRegions (out HPS.Point[][][] out_loops_array, out HPS.Drawing.ClipSpace[] out_spaces, out HPS.Drawing.ClipOperation[] out_operations, out HPS.MatrixKit[] out_matrices) |
Collects all clip regions on 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 | ShowNetCurveAttribute (out HPS.CurveAttributeKit out_kit) |
Shows the net curve attribute settings along this key path. More... | |
bool | ShowNetCuttingSectionAttribute (out HPS.CuttingSectionAttributeKit out_kit) |
Shows the net cutting section attribute settings along this key path. More... | |
bool | ShowNetCylinderAttribute (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 | ShowNetEdgeAttribute (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 | ShowNetLightingAttribute (out HPS.LightingAttributeKit out_kit) |
Shows the net lighting attribute settings along this key path. More... | |
bool | ShowNetLineAttribute (out HPS.LineAttributeKit out_kit) |
Shows the net line attribute settings along this key path. More... | |
bool | ShowNetMarkerAttribute (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 | ShowNetMaterialPalette (out string out_name) |
Shows the material palette name 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 | ShowNetNURBSSurfaceAttribute (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 | ShowNetSphereAttribute (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 | ShowNetTextAttribute (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. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
virtual HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. 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 |
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
|
inline |
Creates an uninitialized key path that refers to no database objects.
|
inline |
Creates a new KeyPath object based on the supplied path.
- Parameters
-
in_path An array of keys arranged from leaf to root.
|
inline |
Copies in_that into this key path.
Member Function Documentation
|
inline |
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
|
inline |
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.
|
inline |
Copies the supplied path into this object.
- Parameters
-
in_that The source of the copy.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
Shows the keys defining this key path.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the net attribute lock settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net bounding along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net camera attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
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.
|
inline |
Shows the net color interpolation attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net condition settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net contour line attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net culling attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net curve attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net cutting section attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net cylinder attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net drawing attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net edge attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net hidden line attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net lighting attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net line attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net marker attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net material mapping attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the material palette name along this key path.
- Returns
- true if a material palette is set along this path, false otherwise.
|
inline |
Shows the net modelling matrix attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net NURBS surface attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net performance attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net selectability attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net sphere attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net subwindow attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net text attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net texture matrix attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net transform mask attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net transparency attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net visibility attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Shows the net visual effects attribute settings along this key path.
- Returns
- true if the setting is valid along this path, false otherwise.
|
inline |
Removes the keys defining this key path.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.KeyPath.cs