Public Member Functions | Protected Member Functions | List of all members
HPS.SegmentKey Class Reference
Inheritance diagram for HPS.SegmentKey:
HPS.Key HPS.Object HPS.WindowKey HPS.ApplicationWindowKey HPS.OffScreenWindowKey HPS.StandAloneWindowKey

Public Member Functions

override void Dispose ()
 
HPS.SegmentKey Down (string in_segment_name, bool in_create_if_not_present)
 
HPS.SegmentKey Down (string in_segment_name)
 
ulong Find (HPS.Search.Type in_request, HPS.Search.Space in_search_space, out HPS.SearchResults out_results)
 
ulong Find (HPS.Search.Type[] in_requests, HPS.Search.Space in_search_space, out HPS.SearchResults out_results)
 
ulong Find (HPS.SearchOptionsKit in_options, out HPS.SearchResults out_results)
 
ulong Find (HPS.SearchOptionsKit in_options)
 
void Flush (HPS.Search.Type in_type_to_remove, HPS.Search.Space in_search_space)
 
void Flush (HPS.Search.Type in_type_to_remove)
 
void Flush ()
 
void Flush (HPS.Search.Type[] in_types_to_remove, HPS.Search.Space in_search_space)
 
void Flush (HPS.Search.Type[] in_types_to_remove)
 
HPS.AttributeLockControl GetAttributeLockControl ()
 
HPS.BoundingControl GetBoundingControl ()
 
HPS.CameraControl GetCameraControl ()
 
HPS.ColorInterpolationControl GetColorInterpolationControl ()
 
HPS.ConditionControl GetConditionControl ()
 
HPS.ContourLineControl GetContourLineControl ()
 
HPS.CullingControl GetCullingControl ()
 
HPS.CurveAttributeControl GetCurveAttributeControl ()
 
HPS.CuttingSectionAttributeControl GetCuttingSectionAttributeControl ()
 
HPS.CylinderAttributeControl GetCylinderAttributeControl ()
 
HPS.DrawingAttributeControl GetDrawingAttributeControl ()
 
HPS.EdgeAttributeControl GetEdgeAttributeControl ()
 
HPS.HiddenLineAttributeControl GetHiddenLineAttributeControl ()
 
HPS.LightingAttributeControl GetLightingAttributeControl ()
 
HPS.LineAttributeControl GetLineAttributeControl ()
 
HPS.MarkerAttributeControl GetMarkerAttributeControl ()
 
HPS.MaterialMappingControl GetMaterialMappingControl ()
 
HPS.ModellingMatrixControl GetModellingMatrixControl ()
 
HPS.NURBSSurfaceAttributeControl GetNURBSSurfaceAttributeControl ()
 
HPS.PerformanceControl GetPerformanceControl ()
 
HPS.PortfolioControl GetPortfolioControl ()
 
HPS.SelectabilityControl GetSelectabilityControl ()
 
HPS.SphereAttributeControl GetSphereAttributeControl ()
 
HPS.StyleControl GetStyleControl ()
 
HPS.SubwindowControl GetSubwindowControl ()
 
HPS.TextAttributeControl GetTextAttributeControl ()
 
HPS.TextureMatrixControl GetTextureMatrixControl ()
 
HPS.TransformMaskControl GetTransformMaskControl ()
 
HPS.TransparencyControl GetTransparencyControl ()
 
HPS.VisibilityControl GetVisibilityControl ()
 
HPS.VisualEffectsControl GetVisualEffectsControl ()
 
HPS.IncludeKey IncludeSegment (HPS.SegmentKey in_seg)
 
HPS.IncludeKey IncludeSegment (HPS.SegmentKey in_seg, HPS.ConditionalExpression in_conditional)
 
HPS.CircleKey InsertCircle (HPS.CircleKit in_kit)
 
HPS.CircleKey InsertCircle (HPS.Point in_start, HPS.Point in_middle, HPS.Point in_end)
 
HPS.CircleKey InsertCircle (HPS.Point in_center, float in_radius, HPS.Vector in_normal)
 
HPS.CircularArcKey InsertCircularArc (HPS.CircularArcKit in_kit)
 
HPS.CircularArcKey InsertCircularArc (HPS.Point in_start, HPS.Point in_middle, HPS.Point in_end)
 
HPS.CircularWedgeKey InsertCircularWedge (HPS.CircularWedgeKit in_kit)
 
HPS.CircularWedgeKey InsertCircularWedge (HPS.Point in_start, HPS.Point in_middle, HPS.Point in_end)
 
HPS.CuttingSectionKey InsertCuttingSection (HPS.Plane in_plane)
 
HPS.CuttingSectionKey InsertCuttingSection (HPS.CuttingSectionKit in_kit)
 
HPS.CuttingSectionKey InsertCuttingSection (HPS.Plane[] in_planes)
 
HPS.CylinderKey InsertCylinder (HPS.CylinderKit in_kit)
 
HPS.CylinderKey InsertCylinder (HPS.Point[] in_points, float[] in_radii, HPS.Cylinder.Capping in_caps)
 
HPS.CylinderKey InsertCylinder (HPS.Point[] in_points, float[] in_radii)
 
HPS.CylinderKey InsertCylinder (HPS.Point in_point1, HPS.Point in_point2, float in_radius, HPS.Cylinder.Capping in_caps)
 
HPS.CylinderKey InsertCylinder (HPS.Point in_point1, HPS.Point in_point2, float in_radius)
 
HPS.DistantLightKey InsertDistantLight (HPS.Vector in_direction)
 
HPS.DistantLightKey InsertDistantLight (HPS.DistantLightKit in_kit)
 
HPS.EllipseKey InsertEllipse (HPS.EllipseKit in_kit)
 
HPS.EllipseKey InsertEllipse (HPS.Point in_center, HPS.Point in_major, HPS.Point in_minor)
 
HPS.EllipticalArcKey InsertEllipticalArc (HPS.EllipticalArcKit in_kit)
 
HPS.EllipticalArcKey InsertEllipticalArc (HPS.Point in_center, HPS.Point in_major, HPS.Point in_minor, float in_start, float in_end)
 
HPS.GridKey InsertGrid (HPS.GridKit in_kit)
 
HPS.GridKey InsertGrid (HPS.Point in_origin, HPS.Point in_first_point, HPS.Point in_second_point, int in_first_count, int in_second_count, HPS.Grid.Type in_type)
 
HPS.GridKey InsertGrid (HPS.Point in_origin, HPS.Point in_first_point, HPS.Point in_second_point, int in_first_count, int in_second_count)
 
HPS.GridKey InsertGrid (HPS.Point in_origin, HPS.Point in_first_point, HPS.Point in_second_point, int in_first_count)
 
HPS.GridKey InsertGrid (HPS.Point in_origin, HPS.Point in_first_point, HPS.Point in_second_point)
 
HPS.GridKey InsertGrid (HPS.Point in_origin, HPS.Point in_first_point)
 
HPS.GridKey InsertGrid (HPS.Point in_origin)
 
HPS.InfiniteLineKey InsertInfiniteLine (HPS.InfiniteLineKit in_kit)
 
HPS.InfiniteLineKey InsertInfiniteLine (HPS.Point in_first, HPS.Point in_second, HPS.InfiniteLine.Type in_type)
 
HPS.LineKey InsertLine (HPS.LineKit in_kit)
 
HPS.LineKey InsertLine (HPS.Point[] in_pts)
 
HPS.LineKey InsertLine (HPS.Point pt1, HPS.Point pt2)
 
HPS.LineKey InsertLineFromGeometry (HPS.CircleKey in_circle, float in_deviation)
 
HPS.LineKey InsertLineFromGeometry (HPS.CircleKey in_circle)
 
HPS.LineKey InsertLineFromGeometry (HPS.CircularArcKey in_circular_arc, float in_deviation)
 
HPS.LineKey InsertLineFromGeometry (HPS.CircularArcKey in_circular_arc)
 
HPS.LineKey InsertLineFromGeometry (HPS.CircularWedgeKey in_circular_wedge, float in_deviation)
 
HPS.LineKey InsertLineFromGeometry (HPS.CircularWedgeKey in_circular_wedge)
 
HPS.LineKey InsertLineFromGeometry (HPS.EllipseKey in_ellipse, float in_deviation)
 
HPS.LineKey InsertLineFromGeometry (HPS.EllipseKey in_ellipse)
 
HPS.LineKey InsertLineFromGeometry (HPS.EllipticalArcKey in_elliptical_arc, float in_deviation)
 
HPS.LineKey InsertLineFromGeometry (HPS.EllipticalArcKey in_elliptical_arc)
 
HPS.LineKey InsertLineFromGeometry (HPS.NURBSCurveKey in_nurbs_curve, float in_deviation)
 
HPS.LineKey InsertLineFromGeometry (HPS.NURBSCurveKey in_nurbs_curve)
 
HPS.MarkerKey InsertMarker (HPS.Point in_position)
 
HPS.MarkerKey InsertMarker (HPS.MarkerKit in_kit)
 
HPS.MeshKey InsertMesh (HPS.MeshKit in_kit)
 
HPS.MeshKey InsertMesh (ulong in_rows, ulong in_columns, HPS.Point[] in_points)
 
HPS.NURBSCurveKey InsertNURBSCurve (HPS.NURBSCurveKit in_kit)
 
HPS.NURBSCurveKey InsertNURBSCurve (ulong in_degree, HPS.Point[] in_points, float[] in_weights, float[] in_knots, float in_start_u, float in_end_u)
 
HPS.NURBSSurfaceKey InsertNURBSSurface (HPS.NURBSSurfaceKit in_kit)
 
HPS.NURBSSurfaceKey InsertNURBSSurface (ulong in_udegree, ulong in_vdegree, ulong in_ucount, ulong in_vcount, HPS.Point[] in_points, float[] in_weights, float[] in_uknots, float[] in_vknots)
 
HPS.NURBSSurfaceKey InsertNURBSSurface (ulong in_udegree, ulong in_vdegree, ulong in_ucount, ulong in_vcount, HPS.Point[] in_points, float[] in_weights, float[] in_uknots, float[] in_vknots, HPS.TrimKit[] in_trims)
 
HPS.PolygonKey InsertPolygon (HPS.PolygonKit in_kit)
 
HPS.PolygonKey InsertPolygon (HPS.Point[] in_points)
 
HPS.ShellKey InsertShell (HPS.ShellKit in_kit)
 
HPS.ShellKey InsertShell (HPS.Point[] in_points, int[] in_facelist)
 
HPS.ShellKey InsertShellByTristrips (HPS.Point[] in_points, int[] in_tristrips)
 
HPS.ShellKey InsertShellFromGeometry (HPS.SphereKey in_sphere)
 
HPS.ShellKey InsertShellFromGeometry (HPS.CylinderKey in_cylinder)
 
HPS.ShellKey InsertShellFromGeometry (HPS.NURBSSurfaceKey in_nurbs_surface)
 
HPS.ShellKey InsertShellFromGeometry (HPS.MeshKey in_mesh)
 
HPS.ShellKey InsertShellFromGeometry (HPS.PolygonKey in_polygon)
 
HPS.ShellKey InsertShellFromGeometry (HPS.EllipseKey in_ellipse)
 
HPS.ShellKey InsertShellFromGeometry (HPS.CircleKey in_circle)
 
HPS.ShellKey InsertShellFromGeometry (HPS.CircularWedgeKey in_circular_wedge)
 
HPS.ShellKey InsertShellFromGeometry (HPS.TextKey in_text)
 
HPS.SphereKey InsertSphere (HPS.SphereKit in_kit)
 
HPS.SphereKey InsertSphere (HPS.Point in_center, float in_radius, HPS.Vector in_axis, HPS.Vector in_prime_meridian)
 
HPS.SphereKey InsertSphere (HPS.Point in_center, float in_radius, HPS.Vector in_axis)
 
HPS.SphereKey InsertSphere (HPS.Point in_center, float in_radius)
 
HPS.SpotlightKey InsertSpotlight (HPS.Point in_position, HPS.Point in_target)
 
HPS.SpotlightKey InsertSpotlight (HPS.SpotlightKit in_kit)
 
HPS.TextKey InsertText (HPS.TextKit in_kit)
 
HPS.TextKey InsertText (HPS.Point in_position, string in_text)
 
string Name ()
 
override HPS.Type ObjectType ()
 
void Optimize (HPS.SegmentOptimizationOptionsKit in_kit)
 
HPS.OptimizeMappingResults OptimizeWithMapping (HPS.SegmentOptimizationOptionsKit in_kit)
 
HPS.ReferenceKey ReferenceGeometry (HPS.Key in_key)
 
HPS.ReferenceKey ReferenceGeometry (HPS.Key in_key, HPS.ConditionalExpression in_conditional)
 
 SegmentKey ()
 
 SegmentKey (HPS.SegmentKey in_that)
 
 SegmentKey (HPS.Key in_that)
 
HPS.SegmentKey SetAttributeLock (HPS.AttributeLockKit in_kit)
 
HPS.SegmentKey SetBounding (HPS.BoundingKit in_kit)
 
HPS.SegmentKey SetCamera (HPS.CameraKit in_kit)
 
HPS.SegmentKey SetColorInterpolation (HPS.ColorInterpolationKit in_kit)
 
HPS.SegmentKey SetCondition (string in_condition)
 
HPS.SegmentKey SetConditions (string[] in_conditions)
 
HPS.SegmentKey SetContourLine (HPS.ContourLineKit in_kit)
 
HPS.SegmentKey SetCulling (HPS.CullingKit in_kit)
 
HPS.SegmentKey SetCurveAttribute (HPS.CurveAttributeKit in_kit)
 
HPS.SegmentKey SetCuttingSectionAttribute (HPS.CuttingSectionAttributeKit in_kit)
 
HPS.SegmentKey SetCylinderAttribute (HPS.CylinderAttributeKit in_kit)
 
HPS.SegmentKey SetDrawingAttribute (HPS.DrawingAttributeKit in_kit)
 
HPS.SegmentKey SetEdgeAttribute (HPS.EdgeAttributeKit in_kit)
 
HPS.SegmentKey SetHiddenLineAttribute (HPS.HiddenLineAttributeKit in_kit)
 
HPS.SegmentKey SetLightingAttribute (HPS.LightingAttributeKit in_kit)
 
HPS.SegmentKey SetLineAttribute (HPS.LineAttributeKit in_kit)
 
HPS.SegmentKey SetMarkerAttribute (HPS.MarkerAttributeKit in_kit)
 
HPS.SegmentKey SetMaterialMapping (HPS.MaterialMappingKit in_kit)
 
HPS.SegmentKey SetMaterialPalette (string in_name)
 
HPS.SegmentKey SetModellingMatrix (HPS.MatrixKit in_kit)
 
HPS.SegmentKey SetName (string in_name)
 
HPS.SegmentKey SetNURBSSurfaceAttribute (HPS.NURBSSurfaceAttributeKit in_kit)
 
HPS.SegmentKey SetPBRMaterial (HPS.PBRMaterialKit in_kit)
 
HPS.SegmentKey SetPerformance (HPS.PerformanceKit in_kit)
 
HPS.SegmentKey SetPriority (int in_priority)
 
HPS.SegmentKey SetSelectability (HPS.SelectabilityKit in_kit)
 
HPS.SegmentKey SetSphereAttribute (HPS.SphereAttributeKit in_kit)
 
HPS.SegmentKey SetSubwindow (HPS.SubwindowKit in_kit)
 
HPS.SegmentKey SetTextAttribute (HPS.TextAttributeKit in_kit)
 
HPS.SegmentKey SetTextureMatrix (HPS.MatrixKit in_kit)
 
HPS.SegmentKey SetTransformMask (HPS.TransformMaskKit in_kit)
 
HPS.SegmentKey SetTransparency (HPS.TransparencyKit in_kit)
 
HPS.SegmentKey SetUserData (IntPtr[] in_indices, byte[][] in_data)
 
HPS.SegmentKey SetUserData (IntPtr in_index, ulong in_bytes, byte[] in_data)
 
HPS.SegmentKey SetUserData (IntPtr in_index, byte[] in_data)
 
HPS.SegmentKey SetVisibility (HPS.VisibilityKit in_kit)
 
HPS.SegmentKey SetVisualEffects (HPS.VisualEffectsKit in_kit)
 
bool ShowAttributeLock (out HPS.AttributeLockKit out_kit)
 
bool ShowBounding (out HPS.BoundingKit out_kit)
 
bool ShowCamera (out HPS.CameraKit out_kit)
 
bool ShowColorInterpolation (out HPS.ColorInterpolationKit out_kit)
 
bool ShowConditions (out string[] out_conditions)
 
bool ShowContourLine (out HPS.ContourLineKit out_kit)
 
bool ShowCulling (out HPS.CullingKit out_kit)
 
bool ShowCurveAttribute (out HPS.CurveAttributeKit out_kit)
 
bool ShowCuttingSectionAttribute (out HPS.CuttingSectionAttributeKit out_kit)
 
bool ShowCylinderAttribute (out HPS.CylinderAttributeKit out_kit)
 
bool ShowDrawingAttribute (out HPS.DrawingAttributeKit out_kit)
 
bool ShowEdgeAttribute (out HPS.EdgeAttributeKit out_kit)
 
bool ShowHiddenLineAttribute (out HPS.HiddenLineAttributeKit out_kit)
 
ulong ShowIncluders (out HPS.SegmentKey[] out_segments)
 
ulong ShowIncluders (out HPS.IncludeKey[] out_includes)
 
bool ShowLightingAttribute (out HPS.LightingAttributeKit out_kit)
 
bool ShowLineAttribute (out HPS.LineAttributeKit out_kit)
 
bool ShowMarkerAttribute (out HPS.MarkerAttributeKit out_kit)
 
bool ShowMaterialMapping (out HPS.MaterialMappingKit out_kit)
 
bool ShowMaterialPalette (out string out_name)
 
bool ShowModellingMatrix (out HPS.MatrixKit out_kit)
 
bool ShowNURBSSurfaceAttribute (out HPS.NURBSSurfaceAttributeKit out_kit)
 
bool ShowPBRMaterial (out HPS.PBRMaterialKit out_kit)
 
bool ShowPerformance (out HPS.PerformanceKit out_kit)
 
bool ShowPriority (out int out_priority)
 
ulong ShowReferrers (out HPS.SegmentKey[] out_segments)
 
ulong ShowReferrers (out HPS.ReferenceKey[] out_references)
 
bool ShowSelectability (out HPS.SelectabilityKit out_kit)
 
bool ShowSphereAttribute (out HPS.SphereAttributeKit out_kit)
 
ulong ShowStylers (out HPS.SegmentKey[] out_segments)
 
ulong ShowStylers (out HPS.StyleKey[] out_styles)
 
ulong ShowSubsegments ()
 
ulong ShowSubsegments (out HPS.SegmentKey[] out_children)
 
bool ShowSubwindow (out HPS.SubwindowKit out_kit)
 
bool ShowTextAttribute (out HPS.TextAttributeKit out_kit)
 
bool ShowTextureMatrix (out HPS.MatrixKit out_kit)
 
bool ShowTransformMask (out HPS.TransformMaskKit out_kit)
 
bool ShowTransparency (out HPS.TransparencyKit out_kit)
 
bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)
 
bool ShowUserData (IntPtr in_index, out byte[] out_data)
 
ulong ShowUserDataCount ()
 
bool ShowUserDataIndices (out IntPtr[] out_indices)
 
bool ShowVisibility (out HPS.VisibilityKit out_kit)
 
bool ShowVisualEffects (out HPS.VisualEffectsKit out_kit)
 
HPS.SegmentKey Subsegment (string in_segment_name, bool in_create_if_not_present)
 
HPS.SegmentKey Subsegment (string in_segment_name)
 
HPS.SegmentKey Subsegment ()
 
HPS.SegmentKey UnsetAllUserData ()
 
HPS.SegmentKey UnsetAttributeLock ()
 
HPS.SegmentKey UnsetBounding ()
 
HPS.SegmentKey UnsetCamera ()
 
HPS.SegmentKey UnsetColorInterpolation ()
 
HPS.SegmentKey UnsetConditions ()
 
HPS.SegmentKey UnsetContourLine ()
 
HPS.SegmentKey UnsetCulling ()
 
HPS.SegmentKey UnsetCurveAttribute ()
 
HPS.SegmentKey UnsetCuttingSectionAttribute ()
 
HPS.SegmentKey UnsetCylinderAttribute ()
 
HPS.SegmentKey UnsetDrawingAttribute ()
 
HPS.SegmentKey UnsetEdgeAttribute ()
 
HPS.SegmentKey UnsetHiddenLineAttribute ()
 
HPS.SegmentKey UnsetLightingAttribute ()
 
HPS.SegmentKey UnsetLineAttribute ()
 
HPS.SegmentKey UnsetMarkerAttribute ()
 
HPS.SegmentKey UnsetMaterialMapping ()
 
HPS.SegmentKey UnsetMaterialPalette ()
 
HPS.SegmentKey UnsetModellingMatrix ()
 
HPS.SegmentKey UnsetNURBSSurfaceAttribute ()
 
HPS.SegmentKey UnsetPBRMaterial ()
 
HPS.SegmentKey UnsetPerformance ()
 
HPS.SegmentKey UnsetPriority ()
 
HPS.SegmentKey UnsetSelectability ()
 
HPS.SegmentKey UnsetSphereAttribute ()
 
HPS.SegmentKey UnsetSubwindow ()
 
HPS.SegmentKey UnsetTextAttribute ()
 
HPS.SegmentKey UnsetTextureMatrix ()
 
HPS.SegmentKey UnsetTransformMask ()
 
HPS.SegmentKey UnsetTransparency ()
 
HPS.SegmentKey UnsetUserData (IntPtr in_index)
 
HPS.SegmentKey UnsetUserData (IntPtr[] in_indices)
 
HPS.SegmentKey UnsetVisibility ()
 
HPS.SegmentKey UnsetVisualEffects ()
 
- Public Member Functions inherited from HPS.Key
virtual void Assign (HPS.Key in_that)
 
HPS.Key CopyTo (HPS.SegmentKey in_destination)
 
void Delete ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Key in_that)
 
ulong GetHash ()
 
override int GetHashCode ()
 
bool HasOwner ()
 
 Key ()
 
 Key (HPS.Key in_that)
 
 Key (HPS.Control in_control)
 
void MoveTo (HPS.SegmentKey in_new_owner)
 
HPS.SegmentKey Owner ()
 
HPS.SegmentKey Up ()
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Protected Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Key
static bool operator!= (HPS.Key a, HPS.Key b)
 
static bool operator== (HPS.Key a, HPS.Key b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The SegmentKey class is a smart pointer to a database object. Segments are the nodes in the scene graph. They can contain attributes, geometry, or other segments, among other things.

Constructor & Destructor Documentation

◆ SegmentKey() [1/3]

HPS.SegmentKey.SegmentKey ( )
inline

An uninitialized key refers to no database object and Type() will return Type.None.

◆ SegmentKey() [2/3]

HPS.SegmentKey.SegmentKey ( HPS.SegmentKey  in_that)
inline

Shares a reference to a database object referred to by in_that.

◆ SegmentKey() [3/3]

HPS.SegmentKey.SegmentKey ( HPS.Key  in_that)
inline

Shares a reference to a database object referred to by in_that. If the key assignment is invalid, this key will revert to an uninitialized state.

Member Function Documentation

◆ Down() [1/2]

HPS.SegmentKey HPS.SegmentKey.Down ( string  in_segment_name,
bool  in_create_if_not_present 
)
inline

Returns the segment contained by this key with name of in_segment_name. If the segment does not exist and the flag in_create_if_not_present is not set, the key returned will be uninitialized.

◆ Down() [2/2]

HPS.SegmentKey HPS.SegmentKey.Down ( string  in_segment_name)
inline

Returns the segment contained by this key with name of in_segment_name. If the segment does not exist and the flag in_create_if_not_present is not set, the key returned will be uninitialized.

◆ Find() [1/4]

ulong HPS.SegmentKey.Find ( HPS.Search.Type  in_request,
HPS.Search.Space  in_search_space,
out HPS.SearchResults  out_results 
)
inline

Searches in_search_space for in_request and returns a handle to the results.

◆ Find() [2/4]

ulong HPS.SegmentKey.Find ( HPS.Search.Type []  in_requests,
HPS.Search.Space  in_search_space,
out HPS.SearchResults  out_results 
)
inline

Searches in_search_space for in_request and returns a handle to the results.

◆ Find() [3/4]

ulong HPS.SegmentKey.Find ( HPS.SearchOptionsKit  in_options,
out HPS.SearchResults  out_results 
)
inline

Searches starting at this segment using in_options and writes found objects into out_results, returns count.

◆ Find() [4/4]

ulong HPS.SegmentKey.Find ( HPS.SearchOptionsKit  in_options)
inline

Searches starting at this segment using in_options, returns count.

◆ Flush() [1/5]

void HPS.SegmentKey.Flush ( HPS.Search.Type  in_type_to_remove,
HPS.Search.Space  in_search_space 
)
inline

Searches in_search_space for in_type_to_remove and deletes all instances from the segment(s).

◆ Flush() [2/5]

void HPS.SegmentKey.Flush ( HPS.Search.Type  in_type_to_remove)
inline

Searches in_search_space for in_type_to_remove and deletes all instances from the segment(s).

◆ Flush() [3/5]

void HPS.SegmentKey.Flush ( )
inline

Searches in_search_space for in_type_to_remove and deletes all instances from the segment(s).

◆ Flush() [4/5]

void HPS.SegmentKey.Flush ( HPS.Search.Type []  in_types_to_remove,
HPS.Search.Space  in_search_space 
)
inline

Searches in_search_space for in_types_to_remove and deletes all instances from the segment(s).

◆ Flush() [5/5]

void HPS.SegmentKey.Flush ( HPS.Search.Type []  in_types_to_remove)
inline

Searches in_search_space for in_types_to_remove and deletes all instances from the segment(s).

◆ GetAttributeLockControl()

HPS.AttributeLockControl HPS.SegmentKey.GetAttributeLockControl ( )
inline

Returns a control that allows the user to manipulate and query details of the attribute locks on this segment.

◆ GetBoundingControl()

HPS.BoundingControl HPS.SegmentKey.GetBoundingControl ( )
inline

Returns a control that allows the user to manipulate and query details of the bounding control on this segment.

◆ GetCullingControl()

HPS.CullingControl HPS.SegmentKey.GetCullingControl ( )
inline

Returns a control that allows the user to manipulate and query details of the culling attribute on this segment.

◆ GetCurveAttributeControl()

HPS.CurveAttributeControl HPS.SegmentKey.GetCurveAttributeControl ( )
inline

Returns a control that allows the user to manipulate and query details of the curve attribute on this segment.

◆ GetCuttingSectionAttributeControl()

HPS.CuttingSectionAttributeControl HPS.SegmentKey.GetCuttingSectionAttributeControl ( )
inline

Returns a control that allows the user to manipulate and query details of the cutting section attributes on this segment.

◆ GetCylinderAttributeControl()

HPS.CylinderAttributeControl HPS.SegmentKey.GetCylinderAttributeControl ( )
inline

Returns a control that allows the user to manipulate and query details of the cylinder attribute on this segment.

◆ GetDrawingAttributeControl()

HPS.DrawingAttributeControl HPS.SegmentKey.GetDrawingAttributeControl ( )
inline

Returns a control that allows the user to manipulate and query details of the drawing attribute on this segment.

◆ GetEdgeAttributeControl()

HPS.EdgeAttributeControl HPS.SegmentKey.GetEdgeAttributeControl ( )
inline

Returns a control that allows the user to manipulate and query details of the edge attribute on this segment.

◆ GetHiddenLineAttributeControl()

HPS.HiddenLineAttributeControl HPS.SegmentKey.GetHiddenLineAttributeControl ( )
inline

Returns a control that allows the user to manipulate and query details of the hidden line attribute on this segment.

◆ GetLightingAttributeControl()

HPS.LightingAttributeControl HPS.SegmentKey.GetLightingAttributeControl ( )
inline

Returns a control that allows the user to manipulate and query details of the lighting attribute on this segment.

◆ GetLineAttributeControl()

HPS.LineAttributeControl HPS.SegmentKey.GetLineAttributeControl ( )
inline

Returns a control that allows the user to manipulate and query details of the line attribute on this segment.

◆ GetMarkerAttributeControl()

HPS.MarkerAttributeControl HPS.SegmentKey.GetMarkerAttributeControl ( )
inline

Returns a control that allows the user to manipulate and query details of the marker attribute on this segment.

◆ GetMaterialMappingControl()

HPS.MaterialMappingControl HPS.SegmentKey.GetMaterialMappingControl ( )
inline

Returns a control that allows the user to manipulate and query details of the material mapping on this segment.

◆ GetModellingMatrixControl()

HPS.ModellingMatrixControl HPS.SegmentKey.GetModellingMatrixControl ( )
inline

Returns a control that allows the user to manipulate and query details of the modelling matrix on this segment.

◆ GetNURBSSurfaceAttributeControl()

HPS.NURBSSurfaceAttributeControl HPS.SegmentKey.GetNURBSSurfaceAttributeControl ( )
inline

Returns a control that allows the user to manipulate and query details of the NURBS surface attribute on this segment.

◆ GetPerformanceControl()

HPS.PerformanceControl HPS.SegmentKey.GetPerformanceControl ( )
inline

Returns a control that allows the user to manipulate and query details of the performance attribute on this segment.

◆ GetSelectabilityControl()

HPS.SelectabilityControl HPS.SegmentKey.GetSelectabilityControl ( )
inline

Returns a control that allows the user to manipulate and query details of the selectability attribute on this segment.

◆ GetSphereAttributeControl()

HPS.SphereAttributeControl HPS.SegmentKey.GetSphereAttributeControl ( )
inline

Returns a control that allows the user to manipulate and query details of the sphere attribute on this segment.

◆ GetSubwindowControl()

HPS.SubwindowControl HPS.SegmentKey.GetSubwindowControl ( )
inline

Returns a control that allows the user to manipulate and query details of the subwindow attribute on this segment.

◆ GetTextAttributeControl()

HPS.TextAttributeControl HPS.SegmentKey.GetTextAttributeControl ( )
inline

Returns a control that allows the user to manipulate and query details of the text attribute on this segment.

◆ GetTextureMatrixControl()

HPS.TextureMatrixControl HPS.SegmentKey.GetTextureMatrixControl ( )
inline

Returns a control that allows the user to manipulate and query details of the texture matrix on this segment.

◆ GetTransformMaskControl()

HPS.TransformMaskControl HPS.SegmentKey.GetTransformMaskControl ( )
inline

Returns a control that allows the user to manipulate and query details of the transform mask on this segment.

◆ GetTransparencyControl()

HPS.TransparencyControl HPS.SegmentKey.GetTransparencyControl ( )
inline

Returns a control that allows the user to manipulate and query details of the transparency attribute on this segment.

◆ GetVisibilityControl()

HPS.VisibilityControl HPS.SegmentKey.GetVisibilityControl ( )
inline

Returns a control that allows the user to manipulate and query details of the visibility attribute on this segment.

◆ GetVisualEffectsControl()

HPS.VisualEffectsControl HPS.SegmentKey.GetVisualEffectsControl ( )
inline

Returns a control that allows the user to manipulate and query details of the visual effects attribute on this segment.

◆ IncludeSegment() [1/2]

HPS.IncludeKey HPS.SegmentKey.IncludeSegment ( HPS.SegmentKey  in_seg)
inline

Creates a link between this segment and in_seg, returns a handle to the include itself. Included segments are treated like child segments for most operations including drawing.

◆ IncludeSegment() [2/2]

HPS.IncludeKey HPS.SegmentKey.IncludeSegment ( HPS.SegmentKey  in_seg,
HPS.ConditionalExpression  in_conditional 
)
inline

Creates a link between this segment and in_seg, returns a handle to the include itself. The link will only be applied if the condition is set in the draw path. Included segments are treated like child segments for most operations including drawing.

◆ InsertCircle() [1/3]

HPS.CircleKey HPS.SegmentKey.InsertCircle ( HPS.CircleKit  in_kit)
inline

Creates a new circle geometry in this segment and returns a key to it.

◆ InsertCircle() [2/3]

HPS.CircleKey HPS.SegmentKey.InsertCircle ( HPS.Point  in_start,
HPS.Point  in_middle,
HPS.Point  in_end 
)
inline

Creates a new circle geometry in this segment and returns a key to it.

◆ InsertCircle() [3/3]

HPS.CircleKey HPS.SegmentKey.InsertCircle ( HPS.Point  in_center,
float  in_radius,
HPS.Vector  in_normal 
)
inline

Creates a new circle geometry in this segment and returns a key to it.

◆ InsertCircularArc() [1/2]

HPS.CircularArcKey HPS.SegmentKey.InsertCircularArc ( HPS.CircularArcKit  in_kit)
inline

Creates a new circular arc geometry in this segment and returns a key to it.

◆ InsertCircularArc() [2/2]

HPS.CircularArcKey HPS.SegmentKey.InsertCircularArc ( HPS.Point  in_start,
HPS.Point  in_middle,
HPS.Point  in_end 
)
inline

Creates a new circular arc geometry in this segment and returns a key to it.

◆ InsertCircularWedge() [1/2]

HPS.CircularWedgeKey HPS.SegmentKey.InsertCircularWedge ( HPS.CircularWedgeKit  in_kit)
inline

Creates a new circular wedge geometry in this segment and returns a key to it.

◆ InsertCircularWedge() [2/2]

HPS.CircularWedgeKey HPS.SegmentKey.InsertCircularWedge ( HPS.Point  in_start,
HPS.Point  in_middle,
HPS.Point  in_end 
)
inline

Creates a new circular wedge geometry in this segment and returns a key to it.

◆ InsertCuttingSection() [1/3]

HPS.CuttingSectionKey HPS.SegmentKey.InsertCuttingSection ( HPS.Plane  in_plane)
inline

Creates a new cutting section in this segment and returns a key to it.

◆ InsertCuttingSection() [2/3]

HPS.CuttingSectionKey HPS.SegmentKey.InsertCuttingSection ( HPS.CuttingSectionKit  in_kit)
inline

Creates a new cutting section in this segment and returns a key to it.

◆ InsertCuttingSection() [3/3]

HPS.CuttingSectionKey HPS.SegmentKey.InsertCuttingSection ( HPS.Plane []  in_planes)
inline

Creates a new cutting section in this segment and returns a key to it.

◆ InsertCylinder() [1/5]

HPS.CylinderKey HPS.SegmentKey.InsertCylinder ( HPS.CylinderKit  in_kit)
inline

Creates a new cylinder geometry in this segment and returns a key to it.

◆ InsertCylinder() [2/5]

HPS.CylinderKey HPS.SegmentKey.InsertCylinder ( HPS.Point []  in_points,
float []  in_radii,
HPS.Cylinder.Capping  in_caps 
)
inline

Creates a new cylinder geometry in this segment and returns a key to it.

◆ InsertCylinder() [3/5]

HPS.CylinderKey HPS.SegmentKey.InsertCylinder ( HPS.Point []  in_points,
float []  in_radii 
)
inline

Creates a new cylinder geometry in this segment and returns a key to it.

◆ InsertCylinder() [4/5]

HPS.CylinderKey HPS.SegmentKey.InsertCylinder ( HPS.Point  in_point1,
HPS.Point  in_point2,
float  in_radius,
HPS.Cylinder.Capping  in_caps 
)
inline

Creates a new cylinder geometry in this segment and returns a key to it.

◆ InsertCylinder() [5/5]

HPS.CylinderKey HPS.SegmentKey.InsertCylinder ( HPS.Point  in_point1,
HPS.Point  in_point2,
float  in_radius 
)
inline

Creates a new cylinder geometry in this segment and returns a key to it.

◆ InsertDistantLight() [1/2]

HPS.DistantLightKey HPS.SegmentKey.InsertDistantLight ( HPS.Vector  in_direction)
inline

Creates a new distant light geometry in this segment and returns a key to it.

◆ InsertDistantLight() [2/2]

HPS.DistantLightKey HPS.SegmentKey.InsertDistantLight ( HPS.DistantLightKit  in_kit)
inline

Creates a new distant light geometry in this segment and returns a key to it.

◆ InsertEllipse() [1/2]

HPS.EllipseKey HPS.SegmentKey.InsertEllipse ( HPS.EllipseKit  in_kit)
inline

Creates a new ellipse geometry in this segment and returns a key to it.

◆ InsertEllipse() [2/2]

HPS.EllipseKey HPS.SegmentKey.InsertEllipse ( HPS.Point  in_center,
HPS.Point  in_major,
HPS.Point  in_minor 
)
inline

Creates a new ellipse geometry in this segment and returns a key to it.

◆ InsertEllipticalArc() [1/2]

HPS.EllipticalArcKey HPS.SegmentKey.InsertEllipticalArc ( HPS.EllipticalArcKit  in_kit)
inline

Creates a new elliptical arc geometry in this segment and returns a key to it.

◆ InsertEllipticalArc() [2/2]

HPS.EllipticalArcKey HPS.SegmentKey.InsertEllipticalArc ( HPS.Point  in_center,
HPS.Point  in_major,
HPS.Point  in_minor,
float  in_start,
float  in_end 
)
inline

Creates a new elliptical arc geometry in this segment and returns a key to it.

◆ InsertGrid() [1/7]

HPS.GridKey HPS.SegmentKey.InsertGrid ( HPS.GridKit  in_kit)
inline

Creates a new grid in this segment and returns a key to it.

◆ InsertGrid() [2/7]

HPS.GridKey HPS.SegmentKey.InsertGrid ( HPS.Point  in_origin,
HPS.Point  in_first_point,
HPS.Point  in_second_point,
int  in_first_count,
int  in_second_count,
HPS.Grid.Type  in_type 
)
inline

Creates a new grid in this segment and returns a key to it.

◆ InsertGrid() [3/7]

HPS.GridKey HPS.SegmentKey.InsertGrid ( HPS.Point  in_origin,
HPS.Point  in_first_point,
HPS.Point  in_second_point,
int  in_first_count,
int  in_second_count 
)
inline

Creates a new grid in this segment and returns a key to it.

◆ InsertGrid() [4/7]

HPS.GridKey HPS.SegmentKey.InsertGrid ( HPS.Point  in_origin,
HPS.Point  in_first_point,
HPS.Point  in_second_point,
int  in_first_count 
)
inline

Creates a new grid in this segment and returns a key to it.

◆ InsertGrid() [5/7]

HPS.GridKey HPS.SegmentKey.InsertGrid ( HPS.Point  in_origin,
HPS.Point  in_first_point,
HPS.Point  in_second_point 
)
inline

Creates a new grid in this segment and returns a key to it.

◆ InsertGrid() [6/7]

HPS.GridKey HPS.SegmentKey.InsertGrid ( HPS.Point  in_origin,
HPS.Point  in_first_point 
)
inline

Creates a new grid in this segment and returns a key to it.

◆ InsertGrid() [7/7]

HPS.GridKey HPS.SegmentKey.InsertGrid ( HPS.Point  in_origin)
inline

Creates a new grid in this segment and returns a key to it.

◆ InsertInfiniteLine() [1/2]

HPS.InfiniteLineKey HPS.SegmentKey.InsertInfiniteLine ( HPS.InfiniteLineKit  in_kit)
inline

Creates a new infinite line geometry in this segment and returns a key to it.

◆ InsertInfiniteLine() [2/2]

HPS.InfiniteLineKey HPS.SegmentKey.InsertInfiniteLine ( HPS.Point  in_first,
HPS.Point  in_second,
HPS.InfiniteLine.Type  in_type 
)
inline

Creates a new infinite line geometry in this segment and returns a key to it.

◆ InsertLine() [1/3]

HPS.LineKey HPS.SegmentKey.InsertLine ( HPS.LineKit  in_kit)
inline

Creates a new line geometry in this segment and returns a key to it.

◆ InsertLine() [2/3]

HPS.LineKey HPS.SegmentKey.InsertLine ( HPS.Point []  in_pts)
inline

Creates a new line geometry in this segment and returns a key to it.

◆ InsertLine() [3/3]

HPS.LineKey HPS.SegmentKey.InsertLine ( HPS.Point  pt1,
HPS.Point  pt2 
)
inline

Creates a new line geometry in this segment and returns a key to it.

◆ InsertLineFromGeometry() [1/12]

HPS.LineKey HPS.SegmentKey.InsertLineFromGeometry ( HPS.CircleKey  in_circle,
float  in_deviation 
)
inline

Creates a new line geometry in this segment which approximates the given circle and returns a key to it.

Parameters
in_circleThe CircleKey that will be used to compute the line approximation.
in_deviationThe distance in object space from the line approximation to the circle. Default value is -1.0f, which tells Visualize to compute a deviation based on the bounding volume of the circle.
Returns
The reference to the newly created line. Will have a type of Type.None if line insertion failed.

◆ InsertLineFromGeometry() [2/12]

HPS.LineKey HPS.SegmentKey.InsertLineFromGeometry ( HPS.CircleKey  in_circle)
inline

Creates a new line geometry in this segment which approximates the given circle and returns a key to it.

Parameters
in_circleThe CircleKey that will be used to compute the line approximation.
Returns
The reference to the newly created line. Will have a type of Type.None if line insertion failed.

◆ InsertLineFromGeometry() [3/12]

HPS.LineKey HPS.SegmentKey.InsertLineFromGeometry ( HPS.CircularArcKey  in_circular_arc,
float  in_deviation 
)
inline

Creates a new line geometry in this segment which approximates the given circular arc and returns a key to it.

Parameters
in_circular_arcThe CircularArcKey that will be used to compute the line approximation.
in_deviationThe distance in object space from the line approximation to the circular arc. Default value is -1.0f, which tells Visualize to compute a deviation based on the bounding volume of the circular arc.
Returns
The reference to the newly created line. Will have a type of Type.None if line insertion failed.

◆ InsertLineFromGeometry() [4/12]

HPS.LineKey HPS.SegmentKey.InsertLineFromGeometry ( HPS.CircularArcKey  in_circular_arc)
inline

Creates a new line geometry in this segment which approximates the given circular arc and returns a key to it.

Parameters
in_circular_arcThe CircularArcKey that will be used to compute the line approximation.
Returns
The reference to the newly created line. Will have a type of Type.None if line insertion failed.

◆ InsertLineFromGeometry() [5/12]

HPS.LineKey HPS.SegmentKey.InsertLineFromGeometry ( HPS.CircularWedgeKey  in_circular_wedge,
float  in_deviation 
)
inline

Creates a new line geometry in this segment which approximates the given circular wedge and returns a key to it.

Parameters
in_circular_wedgeThe CircularWedgeKey that will be used to compute the line approximation.
in_deviationThe distance in object space from the line approximation to the circular wedge. Default value is -1.0f, which tells Visualize to compute a deviation based on the bounding volume of the circular wedge.
Returns
The reference to the newly created line. Will have a type of Type.None if line insertion failed.

◆ InsertLineFromGeometry() [6/12]

HPS.LineKey HPS.SegmentKey.InsertLineFromGeometry ( HPS.CircularWedgeKey  in_circular_wedge)
inline

Creates a new line geometry in this segment which approximates the given circular wedge and returns a key to it.

Parameters
in_circular_wedgeThe CircularWedgeKey that will be used to compute the line approximation.
Returns
The reference to the newly created line. Will have a type of Type.None if line insertion failed.

◆ InsertLineFromGeometry() [7/12]

HPS.LineKey HPS.SegmentKey.InsertLineFromGeometry ( HPS.EllipseKey  in_ellipse,
float  in_deviation 
)
inline

Creates a new line geometry in this segment which approximates the given ellipse and returns a key to it.

Parameters
in_ellipseThe EllipseKey that will be used to compute the line approximation.
in_deviationThe distance in object space from the line approximation to the ellipse. Default value is -1.0f, which tells Visualize to compute a deviation based on the bounding volume of the ellipse.
Returns
The reference to the newly created line. Will have a type of Type.None if line insertion failed.

◆ InsertLineFromGeometry() [8/12]

HPS.LineKey HPS.SegmentKey.InsertLineFromGeometry ( HPS.EllipseKey  in_ellipse)
inline

Creates a new line geometry in this segment which approximates the given ellipse and returns a key to it.

Parameters
in_ellipseThe EllipseKey that will be used to compute the line approximation.
Returns
The reference to the newly created line. Will have a type of Type.None if line insertion failed.

◆ InsertLineFromGeometry() [9/12]

HPS.LineKey HPS.SegmentKey.InsertLineFromGeometry ( HPS.EllipticalArcKey  in_elliptical_arc,
float  in_deviation 
)
inline

Creates a new line geometry in this segment which approximates the given elliptical arc and returns a key to it.

Parameters
in_elliptical_arcThe EllipticalArcKey that will be used to compute the line approximation.
in_deviationThe distance in object space from the line approximation to the elliptical arc. Default value is -1.0f, which tells Visualize to compute a deviation based on the bounding volume of the elliptical arc.
Returns
The reference to the newly created line. Will have a type of Type.None if line insertion failed.

◆ InsertLineFromGeometry() [10/12]

HPS.LineKey HPS.SegmentKey.InsertLineFromGeometry ( HPS.EllipticalArcKey  in_elliptical_arc)
inline

Creates a new line geometry in this segment which approximates the given elliptical arc and returns a key to it.

Parameters
in_elliptical_arcThe EllipticalArcKey that will be used to compute the line approximation.
Returns
The reference to the newly created line. Will have a type of Type.None if line insertion failed.

◆ InsertLineFromGeometry() [11/12]

HPS.LineKey HPS.SegmentKey.InsertLineFromGeometry ( HPS.NURBSCurveKey  in_nurbs_curve,
float  in_deviation 
)
inline

Creates a new line geometry in this segment which approximates the given NURBS curve and returns a key to it.

Parameters
in_nurbs_curveThe NURBSCurveKey that will be used to compute the line approximation.
in_deviationThe distance in object space from the line approximation to the NURBS curve. Default value is -1.0f, which tells Visualize to compute a deviation based on the bounding volume of the NURBS curve.
Returns
The reference to the newly created line. Will have a type of Type.None if line insertion failed.

◆ InsertLineFromGeometry() [12/12]

HPS.LineKey HPS.SegmentKey.InsertLineFromGeometry ( HPS.NURBSCurveKey  in_nurbs_curve)
inline

Creates a new line geometry in this segment which approximates the given NURBS curve and returns a key to it.

Parameters
in_nurbs_curveThe NURBSCurveKey that will be used to compute the line approximation.
Returns
The reference to the newly created line. Will have a type of Type.None if line insertion failed.

◆ InsertMarker() [1/2]

HPS.MarkerKey HPS.SegmentKey.InsertMarker ( HPS.Point  in_position)
inline

Creates a new marker geometry in this segment and returns a key to it.

◆ InsertMarker() [2/2]

HPS.MarkerKey HPS.SegmentKey.InsertMarker ( HPS.MarkerKit  in_kit)
inline

Creates a new marker geometry in this segment and returns a key to it.

◆ InsertMesh() [1/2]

HPS.MeshKey HPS.SegmentKey.InsertMesh ( HPS.MeshKit  in_kit)
inline

Creates a new mesh geometry in this segment and returns a key to it.

◆ InsertMesh() [2/2]

HPS.MeshKey HPS.SegmentKey.InsertMesh ( ulong  in_rows,
ulong  in_columns,
HPS.Point []  in_points 
)
inline

Creates a new mesh geometry in this segment and returns a key to it.

◆ InsertNURBSCurve() [1/2]

HPS.NURBSCurveKey HPS.SegmentKey.InsertNURBSCurve ( HPS.NURBSCurveKit  in_kit)
inline

Creates a new NURBS curve geometry in this segment and returns a key to it.

◆ InsertNURBSCurve() [2/2]

HPS.NURBSCurveKey HPS.SegmentKey.InsertNURBSCurve ( ulong  in_degree,
HPS.Point []  in_points,
float []  in_weights,
float []  in_knots,
float  in_start_u,
float  in_end_u 
)
inline

Creates a new NURBS curve geometry in this segment and returns a key to it.

◆ InsertNURBSSurface() [1/3]

HPS.NURBSSurfaceKey HPS.SegmentKey.InsertNURBSSurface ( HPS.NURBSSurfaceKit  in_kit)
inline

Creates a new NURBS surface geometry in this segment and returns a key to it.

◆ InsertNURBSSurface() [2/3]

HPS.NURBSSurfaceKey HPS.SegmentKey.InsertNURBSSurface ( ulong  in_udegree,
ulong  in_vdegree,
ulong  in_ucount,
ulong  in_vcount,
HPS.Point []  in_points,
float []  in_weights,
float []  in_uknots,
float []  in_vknots 
)
inline

Creates a new NURBS surface geometry in this segment and returns a key to it.

◆ InsertNURBSSurface() [3/3]

HPS.NURBSSurfaceKey HPS.SegmentKey.InsertNURBSSurface ( ulong  in_udegree,
ulong  in_vdegree,
ulong  in_ucount,
ulong  in_vcount,
HPS.Point []  in_points,
float []  in_weights,
float []  in_uknots,
float []  in_vknots,
HPS.TrimKit []  in_trims 
)
inline

Creates a new NURBS surface geometry in this segment and returns a key to it.

◆ InsertPolygon() [1/2]

HPS.PolygonKey HPS.SegmentKey.InsertPolygon ( HPS.PolygonKit  in_kit)
inline

Creates a new polygon geometry in this segment and returns a key to it.

◆ InsertPolygon() [2/2]

HPS.PolygonKey HPS.SegmentKey.InsertPolygon ( HPS.Point []  in_points)
inline

Creates a new polygon geometry in this segment and returns a key to it.

◆ InsertShell() [1/2]

HPS.ShellKey HPS.SegmentKey.InsertShell ( HPS.ShellKit  in_kit)
inline

Creates a new shell geometry in this segment and returns a key to it.

◆ InsertShell() [2/2]

HPS.ShellKey HPS.SegmentKey.InsertShell ( HPS.Point []  in_points,
int []  in_facelist 
)
inline

Creates a new shell geometry in this segment and returns a key to it.

◆ InsertShellByTristrips()

HPS.ShellKey HPS.SegmentKey.InsertShellByTristrips ( HPS.Point []  in_points,
int []  in_tristrips 
)
inline

Creates a new shell geometry in this segment and then returns a key to it. <programlisting filename="00700_insert_shell_by_tristrips.cpp">

Parameters
in_pointsAn array of HPS.Point that will serve as vertices in the tri-strip.
in_tristripsAn array of integers that designates the order of the vertices. The first number indicates the number of vertices in a tri-strip. For example, the following declaration specifies two tri-strips, the first with three vertices and the second with five: IntArray triStripIndex = { 3, 0, 1, 2, 5, 3, 4, 5, 6, 7 };

◆ InsertShellFromGeometry() [1/9]

HPS.ShellKey HPS.SegmentKey.InsertShellFromGeometry ( HPS.SphereKey  in_sphere)
inline

Creates a new shell geometry in this segment which approximates the given sphere and returns a key to it.

Parameters
in_sphereThe SphereKey that will be used to compute the shell approximation.
Returns
The reference to the newly created shell. Will have a type of Type.None if shell insertion failed.

◆ InsertShellFromGeometry() [2/9]

HPS.ShellKey HPS.SegmentKey.InsertShellFromGeometry ( HPS.CylinderKey  in_cylinder)
inline

Creates a new shell geometry in this segment which approximates the given cylinder and returns a key to it.

Parameters
in_cylinderThe CylinderKey that will be used to compute the shell approximation.
Returns
The reference to the newly created shell. Will have a type of Type.None if shell insertion failed.

◆ InsertShellFromGeometry() [3/9]

HPS.ShellKey HPS.SegmentKey.InsertShellFromGeometry ( HPS.NURBSSurfaceKey  in_nurbs_surface)
inline

Creates a new shell geometry in this segment which approximates the given NURBS surface and returns a key to it.

Parameters
in_nurbs_surfaceThe NURBSSurfaceKey that will be used to compute the shell approximation.
Returns
The reference to the newly created shell. Will have a type of Type.None if shell insertion failed.

◆ InsertShellFromGeometry() [4/9]

HPS.ShellKey HPS.SegmentKey.InsertShellFromGeometry ( HPS.MeshKey  in_mesh)
inline

Creates a new shell geometry in this segment which approximates the given mesh and returns a key to it.

Parameters
in_meshThe MeshKey that will be used to compute the shell approximation.
Returns
The reference to the newly created shell. Will have a type of Type.None if shell insertion failed.

◆ InsertShellFromGeometry() [5/9]

HPS.ShellKey HPS.SegmentKey.InsertShellFromGeometry ( HPS.PolygonKey  in_polygon)
inline

Creates a new shell geometry in this segment which approximates the given polygon and returns a key to it.

Parameters
in_polygonThe PolygonKey that will be used to compute the shell approximation.
Returns
The reference to the newly created shell. Will have a type of Type.None if shell insertion failed.

◆ InsertShellFromGeometry() [6/9]

HPS.ShellKey HPS.SegmentKey.InsertShellFromGeometry ( HPS.EllipseKey  in_ellipse)
inline

Creates a new shell geometry in this segment which approximates the given ellipse and returns a key to it.

Parameters
in_ellipseThe EllipseKey that will be used to compute the shell approximation.
Returns
The reference to the newly created shell. Will have a type of Type.None if shell insertion failed.

◆ InsertShellFromGeometry() [7/9]

HPS.ShellKey HPS.SegmentKey.InsertShellFromGeometry ( HPS.CircleKey  in_circle)
inline

Creates a new shell geometry in this segment which approximates the given circle and returns a key to it.

Parameters
in_circleThe CircleKey that will be used to compute the shell approximation.
Returns
The reference to the newly created shell. Will have a type of Type.None if shell insertion failed.

◆ InsertShellFromGeometry() [8/9]

HPS.ShellKey HPS.SegmentKey.InsertShellFromGeometry ( HPS.CircularWedgeKey  in_circular_wedge)
inline

Creates a new shell geometry in this segment which approximates the given circular wedge and returns a key to it.

Parameters
in_circular_wedgeThe CircularWedgeKey that will be used to compute the shell approximation.
Returns
The reference to the newly created shell. Will have a type of Type.None if shell insertion failed.

◆ InsertShellFromGeometry() [9/9]

HPS.ShellKey HPS.SegmentKey.InsertShellFromGeometry ( HPS.TextKey  in_text)
inline

Creates a new shell geometry in this segment which approximates the given text and returns a key to it. The text must be inserted into the window segment in order for this call to succeed.

Parameters
in_textThe TextKey that will be used to compute the shell approximation.
Returns
The reference to the newly created shell. Will have a type of Type.None if shell insertion failed.

◆ InsertSphere() [1/4]

HPS.SphereKey HPS.SegmentKey.InsertSphere ( HPS.SphereKit  in_kit)
inline

Creates a new sphere geometry in this segment and returns a key to it.

Parameters
in_kitThe SphereKit that will define the sphere
Returns
The reference to the newly created sphere. Will have a type of Type.None if sphere insertion failed

◆ InsertSphere() [2/4]

HPS.SphereKey HPS.SegmentKey.InsertSphere ( HPS.Point  in_center,
float  in_radius,
HPS.Vector  in_axis,
HPS.Vector  in_prime_meridian 
)
inline

Creates a new sphere geometry in this segment and returns a key to it.

Parameters
in_centerThe Point that will define the center of the sphere
in_radiusThe radius of the sphere
in_axisThe Vector that will define the axis of the sphere
in_prime_meridianThe Vector that will define the orientation of the sphere (as rotated on its axis)
Returns
The reference to the newly created sphere. Will have a type of Type.None if sphere insertion failed

◆ InsertSphere() [3/4]

HPS.SphereKey HPS.SegmentKey.InsertSphere ( HPS.Point  in_center,
float  in_radius,
HPS.Vector  in_axis 
)
inline

Creates a new sphere geometry in this segment and returns a key to it.

Parameters
in_centerThe Point that will define the center of the sphere
in_radiusThe radius of the sphere
in_axisThe Vector that will define the axis of the sphere
Returns
The reference to the newly created sphere. Will have a type of Type.None if sphere insertion failed

◆ InsertSphere() [4/4]

HPS.SphereKey HPS.SegmentKey.InsertSphere ( HPS.Point  in_center,
float  in_radius 
)
inline

Creates a new sphere geometry in this segment and returns a key to it.

Parameters
in_centerThe Point that will define the center of the sphere
in_radiusThe radius of the sphere
Returns
The reference to the newly created sphere. Will have a type of Type.None if sphere insertion failed

◆ InsertSpotlight() [1/2]

HPS.SpotlightKey HPS.SegmentKey.InsertSpotlight ( HPS.Point  in_position,
HPS.Point  in_target 
)
inline

Creates a new spot light geometry in this segment and returns a key to it.

◆ InsertSpotlight() [2/2]

HPS.SpotlightKey HPS.SegmentKey.InsertSpotlight ( HPS.SpotlightKit  in_kit)
inline

Creates a new spot light geometry in this segment and returns a key to it.

◆ InsertText() [1/2]

HPS.TextKey HPS.SegmentKey.InsertText ( HPS.TextKit  in_kit)
inline

Creates a new text geometry in this segment and returns a key to it.

◆ InsertText() [2/2]

HPS.TextKey HPS.SegmentKey.InsertText ( HPS.Point  in_position,
string  in_text 
)
inline

Creates a new text geometry in this segment and returns a key to it.

Parameters
in_positionThe position, in world coordinates, where the text will be inserted.
in_textThe text UTF-8 encoded string to insert.
Returns
A reference to the newly created TextKey object. Will have a type of Type.None if line insertion failed.

◆ Name()

string HPS.SegmentKey.Name ( )
inline

Returns the name given to this segment when it was created.

◆ ObjectType()

override HPS.Type HPS.SegmentKey.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.Key.

Reimplemented in HPS.StandAloneWindowKey, and HPS.WindowKey.

◆ Optimize()

void HPS.SegmentKey.Optimize ( HPS.SegmentOptimizationOptionsKit  in_kit)
inline

Optimizes this Segment according to the options specified in the SegmentOptimizationOptionsKit.

Parameters
in_kitA SegmentOptimizationOptionsKit that specifies how the Segment should be optimized.

◆ OptimizeWithMapping()

HPS.OptimizeMappingResults HPS.SegmentKey.OptimizeWithMapping ( HPS.SegmentOptimizationOptionsKit  in_kit)
inline

Optimizes this Segment according to the options specified in the SegmentOptimizationOptionsKit.

Note
If shell merging is specified in the SegmentOptimizationOptionsKit then the original shells will be preserved. Original shells may be flushed after merging information has been retrieved from the returned OptimizeMappingResults.
Parameters
in_kitA SegmentOptimizationOptionsKit that specifies how the Segment should be optimized.
Returns
OptimizeMappingResults with information about merged shells.

◆ ReferenceGeometry() [1/2]

HPS.ReferenceKey HPS.SegmentKey.ReferenceGeometry ( HPS.Key  in_key)
inline

References either a geometry key or a segment key in this segment. If the provided key is a geometry key, that geometry will be drawn as though it was in this segment. If the provided key is a segment key, all geometry in that segment will be drawn as though they were in this segment, however no attributes, subsegments or geometry in subsegments will be brought along (though attributes set directly on geometry within the segment will be preserved).

Parameters
in_keyA key to either a piece of geometry or a segment.
Returns
A reference to the newly created geometry reference. This will have a type of Type.None if geometry reference creation failed.

◆ ReferenceGeometry() [2/2]

HPS.ReferenceKey HPS.SegmentKey.ReferenceGeometry ( HPS.Key  in_key,
HPS.ConditionalExpression  in_conditional 
)
inline

Conditionally references either a geometry key or a segment key in this segment. If the provided key is a geometry key, that geometry will be drawn as though it was in this segment. If the provided key is a segment key, all geometry in that segment will be drawn as though they were in this segment, however no attributes, subsegments or geometry in subsegments will be brought along (though attributes set directly on geometry within the segment will be preserved). The referenced geometry will only get drawn in this segment if a condition is set above the geometry reference satisfying the provided condition.

Parameters
in_keyA key to either a piece of geometry or a segment.
in_conditionalA conditional expression which will determine whether the referenced geometry gets drawn for this segment.
Returns
A reference to the newly created geometry reference. This will have a type of Type.None if geometry reference creation failed.

◆ SetAttributeLock()

HPS.SegmentKey HPS.SegmentKey.SetAttributeLock ( HPS.AttributeLockKit  in_kit)
inline

Sets the attribute locks designated by in_kit on this segment.

◆ SetBounding()

HPS.SegmentKey HPS.SegmentKey.SetBounding ( HPS.BoundingKit  in_kit)
inline

Sets the bounding designated by in_kit on this segment.

◆ SetCamera()

HPS.SegmentKey HPS.SegmentKey.SetCamera ( HPS.CameraKit  in_kit)
inline

Sets the camera attribute designated by in_kit on this segment.

◆ SetColorInterpolation()

HPS.SegmentKey HPS.SegmentKey.SetColorInterpolation ( HPS.ColorInterpolationKit  in_kit)
inline

Sets the color interpolation attributes designated by in_kit on this segment.

◆ SetCondition()

HPS.SegmentKey HPS.SegmentKey.SetCondition ( string  in_condition)
inline

Sets in_condition as the only condition on this segment, replacing any existing conditions.

◆ SetConditions()

HPS.SegmentKey HPS.SegmentKey.SetConditions ( string []  in_conditions)
inline

Sets in_conditions as the only conditions on this segment, replacing any existing conditions.

◆ SetContourLine()

HPS.SegmentKey HPS.SegmentKey.SetContourLine ( HPS.ContourLineKit  in_kit)
inline

Sets the contour line attributes designated by in_kit on this segment.

◆ SetCulling()

HPS.SegmentKey HPS.SegmentKey.SetCulling ( HPS.CullingKit  in_kit)
inline

Sets the culling attributes designated by in_kit on this segment.

◆ SetCurveAttribute()

HPS.SegmentKey HPS.SegmentKey.SetCurveAttribute ( HPS.CurveAttributeKit  in_kit)
inline

Sets the curve attributes designated by in_kit on this segment.

◆ SetCuttingSectionAttribute()

HPS.SegmentKey HPS.SegmentKey.SetCuttingSectionAttribute ( HPS.CuttingSectionAttributeKit  in_kit)
inline

Sets the cutting section attributes designated by in_kit on this segment.

◆ SetCylinderAttribute()

HPS.SegmentKey HPS.SegmentKey.SetCylinderAttribute ( HPS.CylinderAttributeKit  in_kit)
inline

Sets the cylinder attributes designated by in_kit on this segment.

◆ SetDrawingAttribute()

HPS.SegmentKey HPS.SegmentKey.SetDrawingAttribute ( HPS.DrawingAttributeKit  in_kit)
inline

Sets the drawing attributes designated by in_kit on this segment.

◆ SetEdgeAttribute()

HPS.SegmentKey HPS.SegmentKey.SetEdgeAttribute ( HPS.EdgeAttributeKit  in_kit)
inline

Sets the edge attributes designated by in_kit on this segment.

◆ SetHiddenLineAttribute()

HPS.SegmentKey HPS.SegmentKey.SetHiddenLineAttribute ( HPS.HiddenLineAttributeKit  in_kit)
inline

Sets the hidden line attributes designated by in_kit on this segment.

◆ SetLightingAttribute()

HPS.SegmentKey HPS.SegmentKey.SetLightingAttribute ( HPS.LightingAttributeKit  in_kit)
inline

Sets the lighting attributes designated by in_kit on this segment.

◆ SetLineAttribute()

HPS.SegmentKey HPS.SegmentKey.SetLineAttribute ( HPS.LineAttributeKit  in_kit)
inline

Sets the line attributes designated by in_kit on this segment.

◆ SetMarkerAttribute()

HPS.SegmentKey HPS.SegmentKey.SetMarkerAttribute ( HPS.MarkerAttributeKit  in_kit)
inline

Sets the marker attributes designated by in_kit on this segment.

◆ SetMaterialMapping()

HPS.SegmentKey HPS.SegmentKey.SetMaterialMapping ( HPS.MaterialMappingKit  in_kit)
inline

Sets the material mappings designated by in_kit on this segment.

◆ SetMaterialPalette()

HPS.SegmentKey HPS.SegmentKey.SetMaterialPalette ( string  in_name)
inline

Applies the material palette associated with in_name to this segment, replacing any existing material palette.

◆ SetModellingMatrix()

HPS.SegmentKey HPS.SegmentKey.SetModellingMatrix ( HPS.MatrixKit  in_kit)
inline

Sets the modelling matrix attributes designated by in_kit on this segment.

◆ SetName()

HPS.SegmentKey HPS.SegmentKey.SetName ( string  in_name)
inline

Sets the new name of this segment.

Returns
A reference to this key

◆ SetNURBSSurfaceAttribute()

HPS.SegmentKey HPS.SegmentKey.SetNURBSSurfaceAttribute ( HPS.NURBSSurfaceAttributeKit  in_kit)
inline

Sets the NURBS surface attributes designated by in_kit on this segment.

◆ SetPBRMaterial()

HPS.SegmentKey HPS.SegmentKey.SetPBRMaterial ( HPS.PBRMaterialKit  in_kit)
inline

Sets a PBR material designated by in_kit on this segment.

◆ SetPerformance()

HPS.SegmentKey HPS.SegmentKey.SetPerformance ( HPS.PerformanceKit  in_kit)
inline

Sets the performance attributes designated by in_kit on this segment.

◆ SetPriority()

HPS.SegmentKey HPS.SegmentKey.SetPriority ( int  in_priority)
inline

Assigns a specific drawing priority value to this segment. It affects the order in which the segment is visited if and only if the rendering algorithm is set to Priority. Segments have a default drawing priority assigned, based on the order that they were created.

Parameters
in_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
A reference to this object.
See also
SubwindowKit.SetRenderingAlgorithm()

◆ SetSelectability()

HPS.SegmentKey HPS.SegmentKey.SetSelectability ( HPS.SelectabilityKit  in_kit)
inline

Sets the selectability attributes designated by in_kit on this segment.

◆ SetSphereAttribute()

HPS.SegmentKey HPS.SegmentKey.SetSphereAttribute ( HPS.SphereAttributeKit  in_kit)
inline

Sets the sphere attributes designated by in_kit on this segment.

◆ SetSubwindow()

HPS.SegmentKey HPS.SegmentKey.SetSubwindow ( HPS.SubwindowKit  in_kit)
inline

Sets the subwindow attributes designated by in_kit on this segment.

◆ SetTextAttribute()

HPS.SegmentKey HPS.SegmentKey.SetTextAttribute ( HPS.TextAttributeKit  in_kit)
inline

Sets the text attributes designated by in_kit on this segment.

◆ SetTextureMatrix()

HPS.SegmentKey HPS.SegmentKey.SetTextureMatrix ( HPS.MatrixKit  in_kit)
inline

Sets the texture matrix attributes designated by in_kit on this segment.

◆ SetTransformMask()

HPS.SegmentKey HPS.SegmentKey.SetTransformMask ( HPS.TransformMaskKit  in_kit)
inline

Sets the transform mask designated by in_kit on this segment.

◆ SetTransparency()

HPS.SegmentKey HPS.SegmentKey.SetTransparency ( HPS.TransparencyKit  in_kit)
inline

Sets the transparency attributes designated by in_kit on this segment.

◆ SetUserData() [1/3]

HPS.SegmentKey HPS.SegmentKey.SetUserData ( IntPtr []  in_indices,
byte  in_data[][] 
)
inline

Sets user data on this key.

Parameters
in_indicesAn array of user data indices to set.
in_dataAn array of bytes of user data to set.
Returns
A reference to this key.

◆ SetUserData() [2/3]

HPS.SegmentKey HPS.SegmentKey.SetUserData ( IntPtr  in_index,
ulong  in_bytes,
byte []  in_data 
)
inline

Sets user data on this key.

Parameters
in_indexThe index of the user data to set.
in_bytesThe number of bytes of user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this key.

◆ SetUserData() [3/3]

HPS.SegmentKey HPS.SegmentKey.SetUserData ( IntPtr  in_index,
byte []  in_data 
)
inline

Sets user data on this key.

Parameters
in_indexThe index of the user data to set.
in_dataThe bytes of user data to set.
Returns
A reference to this key.

◆ SetVisibility()

HPS.SegmentKey HPS.SegmentKey.SetVisibility ( HPS.VisibilityKit  in_kit)
inline

Sets the visibility attribute designated by in_kit on this segment.

◆ SetVisualEffects()

HPS.SegmentKey HPS.SegmentKey.SetVisualEffects ( HPS.VisualEffectsKit  in_kit)
inline

Sets the visual effects attributes designated by in_kit on this segment.

◆ ShowAttributeLock()

bool HPS.SegmentKey.ShowAttributeLock ( out HPS.AttributeLockKit  out_kit)
inline

Shows the attribute locks settings on this segment.

Returns
False if no attribute locks settings exist on this segment.

◆ ShowBounding()

bool HPS.SegmentKey.ShowBounding ( out HPS.BoundingKit  out_kit)
inline

Shows the bounding or bounding settings on this segment.

Returns
False if no bounding or bounding settings on this segment.

◆ ShowCamera()

bool HPS.SegmentKey.ShowCamera ( out HPS.CameraKit  out_kit)
inline

Shows the camera attribute settings on this segment. Returns false if no camera is set on this segment.

◆ ShowColorInterpolation()

bool HPS.SegmentKey.ShowColorInterpolation ( out HPS.ColorInterpolationKit  out_kit)
inline

Shows the color interpolation attribute settings on this segment. Returns false if no color interpolation attribute settings exist on this segment.

◆ ShowContourLine()

bool HPS.SegmentKey.ShowContourLine ( out HPS.ContourLineKit  out_kit)
inline

Shows the contour line attribute settings on this segment. Returns false if no contour line attribute settings exist on this segment.

◆ ShowCulling()

bool HPS.SegmentKey.ShowCulling ( out HPS.CullingKit  out_kit)
inline

Shows the culling attribute settings on this segment.

Returns
False if no culling attribute settings exist on this segment.

◆ ShowCurveAttribute()

bool HPS.SegmentKey.ShowCurveAttribute ( out HPS.CurveAttributeKit  out_kit)
inline

Shows the curve attribute settings on this segment. Returns false if no curve attribute settings exist on this segment.

◆ ShowCuttingSectionAttribute()

bool HPS.SegmentKey.ShowCuttingSectionAttribute ( out HPS.CuttingSectionAttributeKit  out_kit)
inline

Shows the cutting section attribute settings on this segment. Returns false if no cutting section attribute settings exist on this segment.

◆ ShowCylinderAttribute()

bool HPS.SegmentKey.ShowCylinderAttribute ( out HPS.CylinderAttributeKit  out_kit)
inline

Shows the cylinder attribute settings on this segment. Returns false if no cylinder attribute settings exist on this segment.

◆ ShowDrawingAttribute()

bool HPS.SegmentKey.ShowDrawingAttribute ( out HPS.DrawingAttributeKit  out_kit)
inline

Shows the drawing attribute settings on this segment. Returns false if no drawing settings exist on this segment.

◆ ShowEdgeAttribute()

bool HPS.SegmentKey.ShowEdgeAttribute ( out HPS.EdgeAttributeKit  out_kit)
inline

Shows the edge attribute settings on this segment. Returns false if no edge attribute settings exist on this segment.

◆ ShowHiddenLineAttribute()

bool HPS.SegmentKey.ShowHiddenLineAttribute ( out HPS.HiddenLineAttributeKit  out_kit)
inline

Shows the hidden line attribute settings on this segment. Returns false if no hidden line settings exist on this segment.

◆ ShowIncluders() [1/2]

ulong HPS.SegmentKey.ShowIncluders ( out HPS.SegmentKey []  out_segments)
inline

Shows the all the segments which contain includes of this key.

Parameters
out_segmentsThe list of segments which contains includes of this key.
Returns
The number of segments which contain includes of this key.

◆ ShowIncluders() [2/2]

ulong HPS.SegmentKey.ShowIncluders ( out HPS.IncludeKey []  out_includes)
inline

Shows the all the includes of this key.

Parameters
out_includesThe list of all includes of this key.
Returns
The number of includes of this key.

◆ ShowLightingAttribute()

bool HPS.SegmentKey.ShowLightingAttribute ( out HPS.LightingAttributeKit  out_kit)
inline

Shows the lighting attribute settings on this segment. Returns false if no lighting attribute settings exist on this segment.

◆ ShowLineAttribute()

bool HPS.SegmentKey.ShowLineAttribute ( out HPS.LineAttributeKit  out_kit)
inline

Shows the line attribute settings on this segment. Returns false if no line attribute settings exist on this segment.

◆ ShowMarkerAttribute()

bool HPS.SegmentKey.ShowMarkerAttribute ( out HPS.MarkerAttributeKit  out_kit)
inline

Shows the marker attribute settings on this segment. Returns false if no marker attribute settings exist on this segment.

◆ ShowMaterialMapping()

bool HPS.SegmentKey.ShowMaterialMapping ( out HPS.MaterialMappingKit  out_kit)
inline

Shows the material mapping settings on this segment. Returns false if no material mapping settings exist on this segment.

◆ ShowMaterialPalette()

bool HPS.SegmentKey.ShowMaterialPalette ( out string  out_name)
inline

Shows the existing material palette, if any, that is active on this segment.

◆ ShowModellingMatrix()

bool HPS.SegmentKey.ShowModellingMatrix ( out HPS.MatrixKit  out_kit)
inline

Shows the modelling matrix setting on this segment. Returns false if no modelling matrix setting exists on this segment.

◆ ShowNURBSSurfaceAttribute()

bool HPS.SegmentKey.ShowNURBSSurfaceAttribute ( out HPS.NURBSSurfaceAttributeKit  out_kit)
inline

Shows the NURBS surface attribute settings on this segment. Returns false if no NURBS surface attribute settings exist on this segment.

◆ ShowPBRMaterial()

bool HPS.SegmentKey.ShowPBRMaterial ( out HPS.PBRMaterialKit  out_kit)
inline

Shows the PBR material settings on this segment. Returns false if no PBR material settings exist on this segment.

◆ ShowPerformance()

bool HPS.SegmentKey.ShowPerformance ( out HPS.PerformanceKit  out_kit)
inline

Shows the performance attribute settings on this segment. Returns false if no performance settings exist on this segment.

◆ ShowPriority()

bool HPS.SegmentKey.ShowPriority ( out int  out_priority)
inline

Shows the drawing priority.

Parameters
out_priorityThe drawing priority, higher priority items are drawn on top of lower priority items.
Returns
true if a priority was specified, false otherwise.

◆ ShowReferrers() [1/2]

ulong HPS.SegmentKey.ShowReferrers ( out HPS.SegmentKey []  out_segments)
inline

Shows the all the segments which contain references to this key. Note that while a segment may only appear once in the returned array, that segment could have multiple references to this key.

Parameters
out_segmentsThe list of segments which contains references to this key.
Returns
The number of segments which contain references to this key.

◆ ShowReferrers() [2/2]

ulong HPS.SegmentKey.ShowReferrers ( out HPS.ReferenceKey []  out_references)
inline

Shows the all the references to this key.

Parameters
out_referencesThe list of all references to this key.
Returns
The number of references to this key.

◆ ShowSelectability()

bool HPS.SegmentKey.ShowSelectability ( out HPS.SelectabilityKit  out_kit)
inline

Shows the selectability attribute settings on this segment.

Returns
False if no selectability settings exist on this segment.

◆ ShowSphereAttribute()

bool HPS.SegmentKey.ShowSphereAttribute ( out HPS.SphereAttributeKit  out_kit)
inline

Shows the sphere attribute settings on this segment.

Returns
False if no sphere attribute settings exist on this segment.

◆ ShowStylers() [1/2]

ulong HPS.SegmentKey.ShowStylers ( out HPS.SegmentKey []  out_segments)
inline

Shows the all the segments which are styled by this key. Note that while a segment may only appear once in the returned array, that segment could have multiple styles which refer to this key.

Parameters
out_segmentsThe list of segments which are styled by this key.
Returns
The number of segments which are styled by this key.

◆ ShowStylers() [2/2]

ulong HPS.SegmentKey.ShowStylers ( out HPS.StyleKey []  out_styles)
inline

Shows the all the styles which refer to this key.

Parameters
out_stylesThe list of all styles which refer to this key.
Returns
The number of styles which refer to this key.

◆ ShowSubwindow()

bool HPS.SegmentKey.ShowSubwindow ( out HPS.SubwindowKit  out_kit)
inline

Shows the subwindow attribute settings on this segment.

Returns
False if no subwindow attribute settings exist on this segment.

◆ ShowTextAttribute()

bool HPS.SegmentKey.ShowTextAttribute ( out HPS.TextAttributeKit  out_kit)
inline

Shows the text attribute settings on this segment. Returns false if no text attribute settings exist on this segment.

◆ ShowTextureMatrix()

bool HPS.SegmentKey.ShowTextureMatrix ( out HPS.MatrixKit  out_kit)
inline

Shows the texture matrix setting on this segment.

Returns
False if no texture matrix setting exists on this segment.

◆ ShowTransformMask()

bool HPS.SegmentKey.ShowTransformMask ( out HPS.TransformMaskKit  out_kit)
inline

Shows the transform mask settings on this segment.

Returns
False if no bounding settings exist on this segment.

◆ ShowTransparency()

bool HPS.SegmentKey.ShowTransparency ( out HPS.TransparencyKit  out_kit)
inline

Shows the transparency attribute settings on this segment.

Returns
False if no transparency attribute settings exist on this segment.

◆ ShowUserData() [1/2]

bool HPS.SegmentKey.ShowUserData ( out IntPtr []  out_indices,
out byte  out_data[][] 
)
inline

Shows all user data for this key.

Parameters
out_indicesAn array of all user data indices set on this key.
out_dataAn array of all user data set on this key.
Returns
true if there is user data on this key, false otherwise.

◆ ShowUserData() [2/2]

bool HPS.SegmentKey.ShowUserData ( IntPtr  in_index,
out byte []  out_data 
)
inline

Shows the user data at a given index for this key.

Parameters
in_indexThe index of the user data to show.
out_dataThe user data at the given index.
Returns
true if there is user data at the given index, false otherwise.

◆ ShowUserDataCount()

ulong HPS.SegmentKey.ShowUserDataCount ( )
inline

Get the number of user data indices set on this key.

◆ ShowUserDataIndices()

bool HPS.SegmentKey.ShowUserDataIndices ( out IntPtr []  out_indices)
inline

Shows the indices of all user data set on this key.

Parameters
out_indicesThe user data indices set on this key.
Returns
The number of user data indices set on this key.

◆ ShowVisibility()

bool HPS.SegmentKey.ShowVisibility ( out HPS.VisibilityKit  out_kit)
inline

Shows the visibility attribute settings on this segment.

Returns
False if no visibility is set on this segment.

◆ ShowVisualEffects()

bool HPS.SegmentKey.ShowVisualEffects ( out HPS.VisualEffectsKit  out_kit)
inline

Shows the visual effects attribute settings on this segment.

Returns
False if no visual effects attribute settings exist on this segment.

◆ Subsegment() [1/3]

HPS.SegmentKey HPS.SegmentKey.Subsegment ( string  in_segment_name,
bool  in_create_if_not_present 
)
inline

Returns the segment contained by this key with name of in_segment_name. The segment will be created automatically if it does not exist. To prevent automatic segment creation, pass a value of false for in_create_not_present.

◆ Subsegment() [2/3]

HPS.SegmentKey HPS.SegmentKey.Subsegment ( string  in_segment_name)
inline

Returns the segment contained by this key with name of in_segment_name. The segment will be created automatically if it does not exist. To prevent automatic segment creation, pass a value of false for in_create_not_present.

◆ Subsegment() [3/3]

HPS.SegmentKey HPS.SegmentKey.Subsegment ( )
inline

Returns the segment contained by this key with name of in_segment_name. The segment will be created automatically if it does not exist. To prevent automatic segment creation, pass a value of false for in_create_not_present.

◆ UnsetAllUserData()

HPS.SegmentKey HPS.SegmentKey.UnsetAllUserData ( )
inline

Removes all user data from this key.

Returns
A reference to this key.

◆ UnsetAttributeLock()

HPS.SegmentKey HPS.SegmentKey.UnsetAttributeLock ( )
inline

Removes all attribute locks settings from this segment.

◆ UnsetBounding()

HPS.SegmentKey HPS.SegmentKey.UnsetBounding ( )
inline

Removes all bounding settings from this segment.

◆ UnsetCamera()

HPS.SegmentKey HPS.SegmentKey.UnsetCamera ( )
inline

Removes any camera set on this segment.

◆ UnsetColorInterpolation()

HPS.SegmentKey HPS.SegmentKey.UnsetColorInterpolation ( )
inline

Removes any color interpolation attributes set on this segment.

◆ UnsetConditions()

HPS.SegmentKey HPS.SegmentKey.UnsetConditions ( )
inline

Unsets all conditions on this segment.

◆ UnsetContourLine()

HPS.SegmentKey HPS.SegmentKey.UnsetContourLine ( )
inline

Removes any contour line attributes set on this segment.

◆ UnsetCulling()

HPS.SegmentKey HPS.SegmentKey.UnsetCulling ( )
inline

Removes all culling attribute settings from this segment.

◆ UnsetCurveAttribute()

HPS.SegmentKey HPS.SegmentKey.UnsetCurveAttribute ( )
inline

Removes all curve attribute settings from this segment.

◆ UnsetCuttingSectionAttribute()

HPS.SegmentKey HPS.SegmentKey.UnsetCuttingSectionAttribute ( )
inline

Removes all cutting section attribute settings from this segment.

◆ UnsetCylinderAttribute()

HPS.SegmentKey HPS.SegmentKey.UnsetCylinderAttribute ( )
inline

Removes all cylinder attribute settings from this segment.

◆ UnsetDrawingAttribute()

HPS.SegmentKey HPS.SegmentKey.UnsetDrawingAttribute ( )
inline

Removes all drawing settings from this segment.

◆ UnsetEdgeAttribute()

HPS.SegmentKey HPS.SegmentKey.UnsetEdgeAttribute ( )
inline

Removes all edge attribute settings from this segment.

◆ UnsetHiddenLineAttribute()

HPS.SegmentKey HPS.SegmentKey.UnsetHiddenLineAttribute ( )
inline

Removes all hidden line settings from this segment.

◆ UnsetLightingAttribute()

HPS.SegmentKey HPS.SegmentKey.UnsetLightingAttribute ( )
inline

Removes all lighting attribute settings from this segment.

◆ UnsetLineAttribute()

HPS.SegmentKey HPS.SegmentKey.UnsetLineAttribute ( )
inline

Removes all line attribute settings from this segment.

◆ UnsetMarkerAttribute()

HPS.SegmentKey HPS.SegmentKey.UnsetMarkerAttribute ( )
inline

Removes all marker attribute settings from this segment.

◆ UnsetMaterialMapping()

HPS.SegmentKey HPS.SegmentKey.UnsetMaterialMapping ( )
inline

Removes all material mapping settings from this segment.

◆ UnsetMaterialPalette()

HPS.SegmentKey HPS.SegmentKey.UnsetMaterialPalette ( )
inline

Removes the existing material palette, if any, that is active on this segment.

◆ UnsetModellingMatrix()

HPS.SegmentKey HPS.SegmentKey.UnsetModellingMatrix ( )
inline

Removes any modelling matrix settings from this segment.

◆ UnsetNURBSSurfaceAttribute()

HPS.SegmentKey HPS.SegmentKey.UnsetNURBSSurfaceAttribute ( )
inline

Removes all NURBS surface attribute settings from this segment.

◆ UnsetPBRMaterial()

HPS.SegmentKey HPS.SegmentKey.UnsetPBRMaterial ( )
inline

Removes all PBR material settings from this segment.

◆ UnsetPerformance()

HPS.SegmentKey HPS.SegmentKey.UnsetPerformance ( )
inline

Removes all performance settings from this segment.

◆ UnsetPriority()

HPS.SegmentKey HPS.SegmentKey.UnsetPriority ( )
inline

Removes the drawing priority setting.

Returns
A reference to this object.

◆ UnsetSelectability()

HPS.SegmentKey HPS.SegmentKey.UnsetSelectability ( )
inline

Removes all selectability settings from this segment.

◆ UnsetSphereAttribute()

HPS.SegmentKey HPS.SegmentKey.UnsetSphereAttribute ( )
inline

Removes all sphere attribute settings from this segment.

◆ UnsetSubwindow()

HPS.SegmentKey HPS.SegmentKey.UnsetSubwindow ( )
inline

Removes all subwindow attribute settings from this segment.

◆ UnsetTextAttribute()

HPS.SegmentKey HPS.SegmentKey.UnsetTextAttribute ( )
inline

Removes all text attribute settings from this segment.

◆ UnsetTextureMatrix()

HPS.SegmentKey HPS.SegmentKey.UnsetTextureMatrix ( )
inline

Removes any texture matrix settings from this segment.

◆ UnsetTransformMask()

HPS.SegmentKey HPS.SegmentKey.UnsetTransformMask ( )
inline

Removes all transform mask settings from this segment.

◆ UnsetTransparency()

HPS.SegmentKey HPS.SegmentKey.UnsetTransparency ( )
inline

Removes all transparency attribute settings from this segment.

◆ UnsetUserData() [1/2]

HPS.SegmentKey HPS.SegmentKey.UnsetUserData ( IntPtr  in_index)
inline

Removes the user data at the given index from this key.

Parameters
in_indexThe index of the user data to remove.
Returns
A reference to this key.

◆ UnsetUserData() [2/2]

HPS.SegmentKey HPS.SegmentKey.UnsetUserData ( IntPtr []  in_indices)
inline

Removes the user data at the given indices from this key.

Parameters
in_indicesThe indices of the user data to remove.
Returns
A reference to this key.

◆ UnsetVisibility()

HPS.SegmentKey HPS.SegmentKey.UnsetVisibility ( )
inline

Removes all visibility settings from this segment.

◆ UnsetVisualEffects()

HPS.SegmentKey HPS.SegmentKey.UnsetVisualEffects ( )
inline

Removes all visual effects attribute settings from this segment.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.SegmentKey.cs