Inheritance diagram for HPS.KeyPath:
HPS.Object

Public Member Functions

HPS.KeyPath Append (HPS.Key in_key)
 
HPS.KeyPath Append (HPS.KeyPath in_key_path)
 
HPS.KeyPath Append (HPS.Key[] in_key_array)
 
HPS.Key At (ulong in_index)
 
HPS.Key Back ()
 
bool ComputeExtent (out HPS.Rectangle out_extent)
 
bool ComputeExtent (HPS.VisibilityKit in_vis, out HPS.Rectangle out_extent)
 
bool ComputeExtent (HPS.Extent.ClipRegion in_clip, out HPS.Rectangle out_extent)
 
bool ComputeExtent (HPS.VisibilityKit in_vis, HPS.Extent.ClipRegion in_clip, out HPS.Rectangle out_extent)
 
bool ComputeTextExtent (string in_text, out float out_xfrac, out float out_yfrac)
 
bool ComputeTransform (HPS.Coordinate.Space in_space, HPS.Coordinate.Space in_output_space, out HPS.MatrixKit out_matrix)
 
bool ConvertCoordinate (HPS.Coordinate.Space in_space, HPS.Point in_point, HPS.Coordinate.Space in_output_space, out HPS.Point out_point)
 
bool ConvertCoordinate (HPS.Coordinate.Space in_space, HPS.Point[] in_points, HPS.Coordinate.Space in_output_space, out HPS.Point[] out_points)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.KeyPath in_that)
 
HPS.Key Front ()
 
ulong GatherCutGeometry (HPS.SegmentKey in_destination, HPS.CutGeometryGatheringOptionsKit in_options)
 
override int GetHashCode ()
 
void Insert (ulong in_index, HPS.Key in_item)
 
 KeyPath ()
 
 KeyPath (HPS.Key[] in_path)
 
 KeyPath (HPS.KeyPath in_that)
 
override HPS.Type ObjectType ()
 
HPS.Key PopBack ()
 
HPS.Key PopFront ()
 
HPS.KeyPath PushBack (HPS.Key in_key)
 
HPS.KeyPath PushBack (HPS.KeyPath in_key_path)
 
HPS.KeyPath PushBack (HPS.Key[] in_key_array)
 
HPS.KeyPath PushFront (HPS.Key in_key)
 
void Remove (HPS.Key in_item)
 
void Remove (ulong in_index)
 
HPS.KeyPath Reverse ()
 
void Set (HPS.KeyPath in_that)
 
HPS.KeyPath SetKeys (HPS.Key[] in_keys)
 
bool ShowEffectiveGlyphDefinition (string in_name, out HPS.GlyphDefinition out_def)
 
bool ShowEffectiveImageDefinition (string in_name, out HPS.ImageDefinition out_def)
 
bool ShowEffectiveLinePatternDefinition (string in_name, out HPS.LinePatternDefinition out_def)
 
bool ShowEffectiveMaterialPaletteDefinition (string in_name, out HPS.MaterialPaletteDefinition out_def)
 
bool ShowEffectiveTextureDefinition (string in_name, out HPS.TextureDefinition out_def)
 
bool ShowKeys (out HPS.Key[] out_keys)
 
bool ShowNetAttributeLock (out HPS.AttributeLockKit out_kit)
 
bool ShowNetBounding (out HPS.BoundingKit out_kit)
 
bool ShowNetBounding (bool in_consider_highlights, out HPS.BoundingKit out_kit)
 
bool ShowNetCamera (out HPS.CameraKit out_kit)
 
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)
 
bool ShowNetColorInterpolation (out HPS.ColorInterpolationKit out_kit)
 
bool ShowNetConditions (out string[] out_conditions)
 
bool ShowNetContourLine (out HPS.ContourLineKit out_kit)
 
bool ShowNetCulling (out HPS.CullingKit out_kit)
 
bool ShowNetCurveAttribute (out HPS.CurveAttributeKit out_kit)
 
bool ShowNetCuttingSectionAttribute (out HPS.CuttingSectionAttributeKit out_kit)
 
bool ShowNetCylinderAttribute (out HPS.CylinderAttributeKit out_kit)
 
bool ShowNetDrawingAttribute (out HPS.DrawingAttributeKit out_kit)
 
bool ShowNetEdgeAttribute (out HPS.EdgeAttributeKit out_kit)
 
bool ShowNetHiddenLineAttribute (out HPS.HiddenLineAttributeKit out_kit)
 
bool ShowNetLightingAttribute (out HPS.LightingAttributeKit out_kit)
 
bool ShowNetLineAttribute (out HPS.LineAttributeKit out_kit)
 
bool ShowNetMarkerAttribute (out HPS.MarkerAttributeKit out_kit)
 
bool ShowNetMaterialMapping (out HPS.MaterialMappingKit out_kit)
 
bool ShowNetMaterialPalette (out string out_name)
 
bool ShowNetModellingMatrix (out HPS.MatrixKit out_kit)
 
bool ShowNetNURBSSurfaceAttribute (out HPS.NURBSSurfaceAttributeKit out_kit)
 
bool ShowNetPBRMaterial (out HPS.PBRMaterialKit out_kit)
 
bool ShowNetPerformance (out HPS.PerformanceKit out_kit)
 
bool ShowNetSelectability (out HPS.SelectabilityKit out_kit)
 
bool ShowNetSphereAttribute (out HPS.SphereAttributeKit out_kit)
 
bool ShowNetSubwindow (out HPS.SubwindowKit out_kit)
 
bool ShowNetTextAttribute (out HPS.TextAttributeKit out_kit)
 
bool ShowNetTextureMatrix (out HPS.MatrixKit out_kit)
 
bool ShowNetTransformMask (out HPS.TransformMaskKit out_kit)
 
bool ShowNetTransparency (out HPS.TransparencyKit out_kit)
 
bool ShowNetVisibility (out HPS.VisibilityKit out_kit)
 
bool ShowNetVisualEffects (out HPS.VisualEffectsKit out_kit)
 
ulong Size ()
 
HPS.KeyPath UnsetKeys ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static bool operator!= (HPS.KeyPath a, HPS.KeyPath b)
 
static bool operator== (HPS.KeyPath a, HPS.KeyPath b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
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

◆ KeyPath() [1/3]

HPS.KeyPath.KeyPath ( )
inline

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

◆ KeyPath() [2/3]

HPS.KeyPath.KeyPath ( HPS.Key []  in_path)
inline

Creates a new KeyPath object based on the supplied path.

Parameters
in_pathAn array of keys arranged from leaf to root.

◆ KeyPath() [3/3]

HPS.KeyPath.KeyPath ( HPS.KeyPath  in_that)
inline

Copies in_that into this key path.

Member Function Documentation

◆ Append() [1/3]

HPS.KeyPath HPS.KeyPath.Append ( HPS.Key  in_key)
inline

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

Deprecated:
This function exists for compatibility. Use KeyPath.PushBack instead.
Parameters
in_keyThe Key to be appended to this.
Returns
A reference to this object.

◆ Append() [2/3]

HPS.KeyPath HPS.KeyPath.Append ( HPS.KeyPath  in_key_path)
inline

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

Deprecated:
This function exists for compatibility. Use KeyPath.PushBack instead.
Parameters
in_key_pathThe KeyPath to be appended to this.
Returns
A reference to this object.

◆ Append() [3/3]

HPS.KeyPath HPS.KeyPath.Append ( HPS.Key []  in_key_array)
inline

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

Deprecated:
This function exists for compatibility. Use KeyPath.PushBack instead.
Parameters
in_key_arrayThe KeyArray to be appended to this.
Returns
A reference to this object.

◆ At()

HPS.Key HPS.KeyPath.At ( ulong  in_index)
inline

Access a Key in this KeyPath object. An HPS.IndexOutOfRangeException exception is thrown if in_index is out of range.

Parameters
in_indexThe index of the Key to access, zero based.
Returns
The Key at position in_index in this key path.

◆ Back()

HPS.Key HPS.KeyPath.Back ( )
inline

Returns the last key of this key path. An HPS.IndexOutOfRangeException exception is thrown if the key path is empty.

Returns
The last key of this key path.

◆ ComputeExtent() [1/4]

bool HPS.KeyPath.ComputeExtent ( out HPS.Rectangle  out_extent)
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_extentThe screen extent of the geometry under this key path.
Returns
true if the operation succeeded, false otherwise.

◆ ComputeExtent() [2/4]

bool HPS.KeyPath.ComputeExtent ( HPS.VisibilityKit  in_vis,
out HPS.Rectangle  out_extent 
)
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_visExplicit visibility settings to acknowledge instead of using the visibilities resolved by this key path.
out_extentThe screen extent of the geometry under this key path.
Returns
true if the operation succeeded, false otherwise.

◆ ComputeExtent() [3/4]

bool HPS.KeyPath.ComputeExtent ( HPS.Extent.ClipRegion  in_clip,
out HPS.Rectangle  out_extent 
)
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_clipThe setting which indicates whether clip regions should be ignored or included.
out_extentThe screen extent of the geometry under this key path.
Returns
true if the operation succeeded, false otherwise.

◆ ComputeExtent() [4/4]

bool HPS.KeyPath.ComputeExtent ( HPS.VisibilityKit  in_vis,
HPS.Extent.ClipRegion  in_clip,
out HPS.Rectangle  out_extent 
)
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_visExplicit visibility settings to acknowledge instead of using the visibilities resolved by this key path.
in_clipThe setting which indicates whether clip regions should be ignored or included.
out_extentThe screen extent of the geometry under this key path.
Returns
true if the operation succeeded, false otherwise.

◆ ComputeTextExtent()

bool HPS.KeyPath.ComputeTextExtent ( string  in_text,
out float  out_xfrac,
out float  out_yfrac 
)
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_textThe text to measure along this keypath
out_xfracThe width of the text extent
out_yfracThe height of the text extent
Returns
true if the operation succeeded, false otherwise.

◆ ComputeTransform()

bool HPS.KeyPath.ComputeTransform ( HPS.Coordinate.Space  in_space,
HPS.Coordinate.Space  in_output_space,
out HPS.MatrixKit  out_matrix 
)
inline

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.

◆ ConvertCoordinate() [1/2]

bool HPS.KeyPath.ConvertCoordinate ( HPS.Coordinate.Space  in_space,
HPS.Point  in_point,
HPS.Coordinate.Space  in_output_space,
out HPS.Point  out_point 
)
inline

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.

◆ ConvertCoordinate() [2/2]

bool HPS.KeyPath.ConvertCoordinate ( HPS.Coordinate.Space  in_space,
HPS.Point []  in_points,
HPS.Coordinate.Space  in_output_space,
out HPS.Point []  out_points 
)
inline

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.

◆ Empty()

override bool HPS.KeyPath.Empty ( )
inlinevirtual

Returns whether the key path is empty.

Returns
true if the key path is empty, false otherwise.

Reimplemented from HPS.Object.

◆ Equals()

bool HPS.KeyPath.Equals ( HPS.KeyPath  in_that)
inline

Check if the source KeyPath is equivalent to this object.

Parameters
in_thatThe source KeyPath to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ Front()

HPS.Key HPS.KeyPath.Front ( )
inline

Returns the first key of this key path. An HPS.IndexOutOfRangeException exception is thrown if the key path is empty.

Returns
The first key of this key path.

◆ GatherCutGeometry()

ulong HPS.KeyPath.GatherCutGeometry ( HPS.SegmentKey  in_destination,
HPS.CutGeometryGatheringOptionsKit  in_options 
)
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_destinationA segment that the capping geometry will be deposited into.
in_optionsOptions for the gathering operation.
Returns
The number of individual caps created.

◆ Insert()

void HPS.KeyPath.Insert ( ulong  in_index,
HPS.Key  in_item 
)
inline

Inserts in_item in the key path before the element at position in_index, increasing the size of the key path by one. An HPS.IndexOutOfRangeException exception is thrown if in_index is out of range.

Parameters
in_indexThe index where in_item will be inserted
in_itemThe key to insert in this key path.

◆ ObjectType()

override HPS.Type HPS.KeyPath.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

◆ PopBack()

HPS.Key HPS.KeyPath.PopBack ( )
inline

Returns the last key of this key path and returns it. An HPS.IndexOutOfRangeException exception is thrown if the key path is empty.

Returns
The last key of this key path.

◆ PopFront()

HPS.Key HPS.KeyPath.PopFront ( )
inline

Returns the first key of this key path and returns it. An HPS.IndexOutOfRangeException exception is thrown if the key path is empty.

Returns
The first key of this key path.

◆ PushBack() [1/3]

HPS.KeyPath HPS.KeyPath.PushBack ( HPS.Key  in_key)
inline

Adds in_key to the end of the key path.

Parameters
in_keyThe key to add to the end of the key path.
Returns
A reference to this object.

◆ PushBack() [2/3]

HPS.KeyPath HPS.KeyPath.PushBack ( HPS.KeyPath  in_key_path)
inline

Appends the keys contained in the supplied key path at the end of this key path

Parameters
in_key_pathThe KeyPath to be appended to this.
Returns
A reference to this object.

◆ PushBack() [3/3]

HPS.KeyPath HPS.KeyPath.PushBack ( HPS.Key []  in_key_array)
inline

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.

◆ PushFront()

HPS.KeyPath HPS.KeyPath.PushFront ( HPS.Key  in_key)
inline

Adds in_key to the front of the key path.

Parameters
in_keyThe key to add to the front of the key path.
Returns
A reference to this object.

◆ Remove() [1/2]

void HPS.KeyPath.Remove ( HPS.Key  in_item)
inline

Traverses the keys in this key path and removes the first one which matches in_item NOTE: A useful KeyPath should not contain duplicate keys.

Parameters
in_itemThe item to remove from the key path.

◆ Remove() [2/2]

void HPS.KeyPath.Remove ( ulong  in_index)
inline

Removes the the key at position in_index from this key path. An HPS.IndexOutOfRangeException exception is thrown if in_index is out of range.

Parameters
in_indexThe index of the key to remove, zero based.

◆ Reverse()

HPS.KeyPath HPS.KeyPath.Reverse ( )
inline

Creates and returns a new KeyPath object, with the keys organized in the reverse order.

Returns
A new KeyPath object, containing keys organized in the reverse order.

◆ Set()

void HPS.KeyPath.Set ( HPS.KeyPath  in_that)
inline

Copies the supplied path into this object.

Parameters
in_thatThe source of the copy.

◆ SetKeys()

HPS.KeyPath HPS.KeyPath.SetKeys ( HPS.Key []  in_keys)
inline

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.

◆ ShowEffectiveGlyphDefinition()

bool HPS.KeyPath.ShowEffectiveGlyphDefinition ( string  in_name,
out HPS.GlyphDefinition  out_def 
)
inline

Shows the effective glyph definition belonging to the input name along this key path.

Parameters
in_nameUTF8-encoded name of the glyph to find along this key path.
out_defThe 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.

◆ ShowEffectiveImageDefinition()

bool HPS.KeyPath.ShowEffectiveImageDefinition ( string  in_name,
out HPS.ImageDefinition  out_def 
)
inline

Shows the effective image definition belonging to the input name along this key path.

Parameters
in_nameUTF8-encoded name of the image to find along this key path.
out_defThe 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.

◆ ShowEffectiveLinePatternDefinition()

bool HPS.KeyPath.ShowEffectiveLinePatternDefinition ( string  in_name,
out HPS.LinePatternDefinition  out_def 
)
inline

Shows the effective line pattern definition belonging to the input name along this key path.

Parameters
in_nameUTF8-encoded name of the line pattern to find along this key path.
out_defThe 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.

◆ ShowEffectiveMaterialPaletteDefinition()

bool HPS.KeyPath.ShowEffectiveMaterialPaletteDefinition ( string  in_name,
out HPS.MaterialPaletteDefinition  out_def 
)
inline

Shows the effective material palette definition belonging to the input name along this key path.

Parameters
in_nameUTF8-encoded name of the material palette to find along this key path.
out_defThe 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.

◆ ShowEffectiveTextureDefinition()

bool HPS.KeyPath.ShowEffectiveTextureDefinition ( string  in_name,
out HPS.TextureDefinition  out_def 
)
inline

Shows the effective texture definition belonging to the input name along this key path.

Parameters
in_nameUTF8-encoded name of the texture to find along this key path.
out_defThe 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.

◆ ShowKeys()

bool HPS.KeyPath.ShowKeys ( out HPS.Key []  out_keys)
inline

Shows the keys defining this key path.

Returns
true if the setting is valid, false otherwise.

◆ ShowNetAttributeLock()

bool HPS.KeyPath.ShowNetAttributeLock ( out HPS.AttributeLockKit  out_kit)
inline

Shows the net attribute lock settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetBounding() [1/2]

bool HPS.KeyPath.ShowNetBounding ( out HPS.BoundingKit  out_kit)
inline

Shows the net bounding along this key path without taking into account attributes set through highlights.

Deprecated:
This function exists for compatibility and ShowNetBounding(bool, BoundingKit &) should be preferred. This function will be removed in HPS 2021.
Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetBounding() [2/2]

bool HPS.KeyPath.ShowNetBounding ( bool  in_consider_highlights,
out HPS.BoundingKit  out_kit 
)
inline

Shows the net bounding along this key path. This function also optionally includes the bounding for geometry affected by in-place highlighting. This includes Show, Hide, and Isolate operations which alter visibility. In order for all highlights to be accounted for, the KeyPath should be complete, extending from the leaf segment or geometry, all the way to the WindowKey or Canvas.

Parameters
in_consider_highlightsIf true, geometry with attributes set by in-place highlighting (including those attributes affecting visibility) will be included in the boundary calculation.
Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetCamera()

bool HPS.KeyPath.ShowNetCamera ( out HPS.CameraKit  out_kit)
inline

Shows the net camera attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetClipRegions()

bool HPS.KeyPath.ShowNetClipRegions ( out HPS.Point  out_loops_array[][][],
out HPS.Drawing.ClipSpace []  out_spaces,
out HPS.Drawing.ClipOperation []  out_operations,
out HPS.MatrixKit []  out_matrices 
)
inline

Collects all clip regions on key path.

Parameters
out_loops_arrayAn array of arrays of loops describing the clip region.
out_spacesAn array of the coordinate spaces in which loops are described.
out_operationsAn array of the operations performed by the clip regions.
out_matricesAn 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.

◆ ShowNetColorInterpolation()

bool HPS.KeyPath.ShowNetColorInterpolation ( out HPS.ColorInterpolationKit  out_kit)
inline

Shows the net color interpolation attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetConditions()

bool HPS.KeyPath.ShowNetConditions ( out string []  out_conditions)
inline

Shows the net condition settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetContourLine()

bool HPS.KeyPath.ShowNetContourLine ( out HPS.ContourLineKit  out_kit)
inline

Shows the net contour line attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetCulling()

bool HPS.KeyPath.ShowNetCulling ( out HPS.CullingKit  out_kit)
inline

Shows the net culling attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetCurveAttribute()

bool HPS.KeyPath.ShowNetCurveAttribute ( out HPS.CurveAttributeKit  out_kit)
inline

Shows the net curve attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetCuttingSectionAttribute()

bool HPS.KeyPath.ShowNetCuttingSectionAttribute ( out HPS.CuttingSectionAttributeKit  out_kit)
inline

Shows the net cutting section attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetCylinderAttribute()

bool HPS.KeyPath.ShowNetCylinderAttribute ( out HPS.CylinderAttributeKit  out_kit)
inline

Shows the net cylinder attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetDrawingAttribute()

bool HPS.KeyPath.ShowNetDrawingAttribute ( out HPS.DrawingAttributeKit  out_kit)
inline

Shows the net drawing attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetEdgeAttribute()

bool HPS.KeyPath.ShowNetEdgeAttribute ( out HPS.EdgeAttributeKit  out_kit)
inline

Shows the net edge attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetHiddenLineAttribute()

bool HPS.KeyPath.ShowNetHiddenLineAttribute ( out HPS.HiddenLineAttributeKit  out_kit)
inline

Shows the net hidden line attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetLightingAttribute()

bool HPS.KeyPath.ShowNetLightingAttribute ( out HPS.LightingAttributeKit  out_kit)
inline

Shows the net lighting attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetLineAttribute()

bool HPS.KeyPath.ShowNetLineAttribute ( out HPS.LineAttributeKit  out_kit)
inline

Shows the net line attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetMarkerAttribute()

bool HPS.KeyPath.ShowNetMarkerAttribute ( out HPS.MarkerAttributeKit  out_kit)
inline

Shows the net marker attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetMaterialMapping()

bool HPS.KeyPath.ShowNetMaterialMapping ( out HPS.MaterialMappingKit  out_kit)
inline

Shows the net material mapping attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetMaterialPalette()

bool HPS.KeyPath.ShowNetMaterialPalette ( out string  out_name)
inline

Shows the material palette name along this key path.

Returns
true if a material palette is set along this path, false otherwise.

◆ ShowNetModellingMatrix()

bool HPS.KeyPath.ShowNetModellingMatrix ( out HPS.MatrixKit  out_kit)
inline

Shows the net modelling matrix attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetNURBSSurfaceAttribute()

bool HPS.KeyPath.ShowNetNURBSSurfaceAttribute ( out HPS.NURBSSurfaceAttributeKit  out_kit)
inline

Shows the net NURBS surface attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetPBRMaterial()

bool HPS.KeyPath.ShowNetPBRMaterial ( out HPS.PBRMaterialKit  out_kit)
inline

Shows the net pbr material attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetPerformance()

bool HPS.KeyPath.ShowNetPerformance ( out HPS.PerformanceKit  out_kit)
inline

Shows the net performance attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetSelectability()

bool HPS.KeyPath.ShowNetSelectability ( out HPS.SelectabilityKit  out_kit)
inline

Shows the net selectability attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetSphereAttribute()

bool HPS.KeyPath.ShowNetSphereAttribute ( out HPS.SphereAttributeKit  out_kit)
inline

Shows the net sphere attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetSubwindow()

bool HPS.KeyPath.ShowNetSubwindow ( out HPS.SubwindowKit  out_kit)
inline

Shows the net subwindow attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetTextAttribute()

bool HPS.KeyPath.ShowNetTextAttribute ( out HPS.TextAttributeKit  out_kit)
inline

Shows the net text attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetTextureMatrix()

bool HPS.KeyPath.ShowNetTextureMatrix ( out HPS.MatrixKit  out_kit)
inline

Shows the net texture matrix attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetTransformMask()

bool HPS.KeyPath.ShowNetTransformMask ( out HPS.TransformMaskKit  out_kit)
inline

Shows the net transform mask attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetTransparency()

bool HPS.KeyPath.ShowNetTransparency ( out HPS.TransparencyKit  out_kit)
inline

Shows the net transparency attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetVisibility()

bool HPS.KeyPath.ShowNetVisibility ( out HPS.VisibilityKit  out_kit)
inline

Shows the net visibility attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ ShowNetVisualEffects()

bool HPS.KeyPath.ShowNetVisualEffects ( out HPS.VisualEffectsKit  out_kit)
inline

Shows the net visual effects attribute settings along this key path.

Returns
true if the setting is valid along this path, false otherwise.

◆ Size()

ulong HPS.KeyPath.Size ( )
inline

Returns the number of Keys contained in this KeyPath object.

Returns
the number of keys in this key path.

◆ UnsetKeys()

HPS.KeyPath HPS.KeyPath.UnsetKeys ( )
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