SegmentKey

class HPS.SegmentKey : public HPS.Key 

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.

Subclassed by HPS.WindowKey

Public Functions

override void Dispose ()

HPS.SegmentKey Down (string in_segment_name): 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.

HPS.SegmentKey Down (string in_segment_name, bool in_create_if_not_present): 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.

ulong Find (HPS.Search.Type in_request, HPS.Search.Space in_search_space, out HPS.SearchResults out_results): Searches in_search_space for in_request and returns a handle to the results.

ulong Find (HPS.Search.Type[] in_requests, HPS.Search.Space in_search_space, out HPS.SearchResults out_results): Searches in_search_space for in_request and returns a handle to the results.

ulong Find (HPS.SearchOptionsKit in_options): Searches starting at this segment using in_options, returns count.

ulong Find (HPS.SearchOptionsKit in_options, out HPS.SearchResults out_results): Searches starting at this segment using in_options and writes found objects into out_results, returns count.

void Flush (): Searches in_search_space for in_type_to_remove and deletes all instances from the segment(s).

void Flush (HPS.Search.Type in_type_to_remove): Searches in_search_space for in_type_to_remove and deletes all instances from the segment(s).

void Flush (HPS.Search.Type in_type_to_remove, HPS.Search.Space in_search_space): Searches in_search_space for in_type_to_remove and deletes all instances from the segment(s).

void Flush (HPS.Search.Type[] in_types_to_remove): Searches in_search_space for in_types_to_remove and deletes all instances from the segment(s).

void Flush (HPS.Search.Type[] in_types_to_remove, HPS.Search.Space in_search_space): Searches in_search_space for in_types_to_remove and deletes all instances from the segment(s).

HPS.AttributeLockControl GetAttributeLockControl (): Returns a control that allows the user to manipulate and query details of the attribute locks on this segment.

HPS.BoundingControl GetBoundingControl (): Returns a control that allows the user to manipulate and query details of the bounding control on this segment.

HPS.CameraControl GetCameraControl ()

return: A control that allows the user to manipulate and query details of the camera attribute on this segment.

HPS.ColorInterpolationControl GetColorInterpolationControl ()

return: A control that allows the user to manipulate and query details of the color interpolation attributes on this segment.

HPS.ConditionControl GetConditionControl ()

return: A control that allows the user to manipulate and query details of conditions on this segment.

HPS.ContourLineControl GetContourLineControl ()

return: A control that allows the user to manipulate and query details of the contour line attributes on this segment.

HPS.CullingControl GetCullingControl (): Returns a control that allows the user to manipulate and query details of the culling attribute on this segment.

HPS.CurveAttributeControl GetCurveAttributeControl (): Returns a control that allows the user to manipulate and query details of the curve attribute on this segment.

HPS.CuttingSectionAttributeControl GetCuttingSectionAttributeControl (): Returns a control that allows the user to manipulate and query details of the cutting section attributes on this segment.

HPS.CylinderAttributeControl GetCylinderAttributeControl (): Returns a control that allows the user to manipulate and query details of the cylinder attribute on this segment.

HPS.DrawingAttributeControl GetDrawingAttributeControl (): Returns a control that allows the user to manipulate and query details of the drawing attribute on this segment.

HPS.EdgeAttributeControl GetEdgeAttributeControl (): Returns a control that allows the user to manipulate and query details of the edge attribute on this segment.

HPS.HiddenLineAttributeControl GetHiddenLineAttributeControl (): Returns a control that allows the user to manipulate and query details of the hidden line attribute on this segment.

HPS.LightingAttributeControl GetLightingAttributeControl (): Returns a control that allows the user to manipulate and query details of the lighting attribute on this segment.

HPS.LineAttributeControl GetLineAttributeControl (): Returns a control that allows the user to manipulate and query details of the line attribute on this segment.

HPS.MarkerAttributeControl GetMarkerAttributeControl (): Returns a control that allows the user to manipulate and query details of the marker attribute on this segment.

HPS.MaterialMappingControl GetMaterialMappingControl (): Returns a control that allows the user to manipulate and query details of the material mapping on this segment.

HPS.ModellingMatrixControl GetModellingMatrixControl (): Returns a control that allows the user to manipulate and query details of the modelling matrix on this segment.

HPS.NURBSSurfaceAttributeControl GetNURBSSurfaceAttributeControl (): Returns a control that allows the user to manipulate and query details of the NURBS surface attribute on this segment.

HPS.PerformanceControl GetPerformanceControl (): Returns a control that allows the user to manipulate and query details of the performance attribute on this segment.

HPS.PortfolioControl GetPortfolioControl ()

return: A control that allows the user to manipulate and query portfolios in use on this segment.

HPS.SelectabilityControl GetSelectabilityControl (): Returns a control that allows the user to manipulate and query details of the selectability attribute on this segment.

HPS.SphereAttributeControl GetSphereAttributeControl (): Returns a control that allows the user to manipulate and query details of the sphere attribute on this segment.

HPS.StyleControl GetStyleControl ()

return: A control that allows the user to manipulate and query details of styles on this segment.

HPS.SubwindowControl GetSubwindowControl (): Returns a control that allows the user to manipulate and query details of the subwindow attribute on this segment.

HPS.TextAttributeControl GetTextAttributeControl (): Returns a control that allows the user to manipulate and query details of the text attribute on this segment.

HPS.TextureMatrixControl GetTextureMatrixControl (): Returns a control that allows the user to manipulate and query details of the texture matrix on this segment.

HPS.TransformMaskControl GetTransformMaskControl (): Returns a control that allows the user to manipulate and query details of the transform mask on this segment.

HPS.TransparencyControl GetTransparencyControl (): Returns a control that allows the user to manipulate and query details of the transparency attribute on this segment.

HPS.VisibilityControl GetVisibilityControl (): Returns a control that allows the user to manipulate and query details of the visibility attribute on this segment.

HPS.VisualEffectsControl GetVisualEffectsControl (): Returns a control that allows the user to manipulate and query details of the visual effects attribute on this segment.

HPS.IncludeKey IncludeSegment (HPS.SegmentKey in_seg): 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.

HPS.IncludeKey IncludeSegment (HPS.SegmentKey in_seg, HPS.ConditionalExpression in_conditional): 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.

HPS.CircleKey InsertCircle (HPS.CircleKit in_kit): Creates a new circle geometry in this segment and returns a key to it.

HPS.CircleKey InsertCircle (HPS.Point in_center, float in_radius, HPS.Vector in_normal): Creates a new circle geometry in this segment and returns a key to it.

HPS.CircleKey InsertCircle (HPS.Point in_start, HPS.Point in_middle, HPS.Point in_end): Creates a new circle geometry in this segment and returns a key to it.

HPS.CircularArcKey InsertCircularArc (HPS.CircularArcKit in_kit): Creates a new circular arc geometry in this segment and returns a key to it.

HPS.CircularArcKey InsertCircularArc (HPS.Point in_start, HPS.Point in_middle, HPS.Point in_end): Creates a new circular arc geometry in this segment and returns a key to it.

HPS.CircularWedgeKey InsertCircularWedge (HPS.CircularWedgeKit in_kit): Creates a new circular wedge geometry in this segment and returns a key to it.

HPS.CircularWedgeKey InsertCircularWedge (HPS.Point in_start, HPS.Point in_middle, HPS.Point in_end): Creates a new circular wedge geometry in this segment and returns a key to it.

HPS.CuttingSectionKey InsertCuttingSection (HPS.CuttingSectionKit in_kit): Creates a new cutting section in this segment and returns a key to it.

HPS.CuttingSectionKey InsertCuttingSection (HPS.Plane in_plane): Creates a new cutting section in this segment and returns a key to it.

HPS.CuttingSectionKey InsertCuttingSection (HPS.Plane[] in_planes): Creates a new cutting section in this segment and returns a key to it.

HPS.CylinderKey InsertCylinder (HPS.CylinderKit in_kit): Creates a new cylinder geometry in this segment and returns a key to it.

HPS.CylinderKey InsertCylinder (HPS.Point in_point1, HPS.Point in_point2, float in_radius): Creates a new cylinder geometry in this segment and returns a key to it.

HPS.CylinderKey InsertCylinder (HPS.Point in_point1, HPS.Point in_point2, float in_radius, HPS.Cylinder.Capping in_caps): Creates a new cylinder geometry in this segment and returns a key to it.

HPS.CylinderKey InsertCylinder (HPS.Point[] in_points, float[] in_radii): Creates a new cylinder geometry in this segment and returns a key to it.

HPS.CylinderKey InsertCylinder (HPS.Point[] in_points, float[] in_radii, HPS.Cylinder.Capping in_caps): Creates a new cylinder geometry in this segment and returns a key to it.

HPS.DistantLightKey InsertDistantLight (HPS.DistantLightKit in_kit): Creates a new distant light geometry in this segment and returns a key to it.

HPS.DistantLightKey InsertDistantLight (HPS.Vector in_direction): Creates a new distant light geometry in this segment and returns a key to it.

HPS.EllipseKey InsertEllipse (HPS.EllipseKit in_kit): Creates a new ellipse geometry in this segment and returns a key to it.

HPS.EllipseKey InsertEllipse (HPS.Point in_center, HPS.Point in_major, HPS.Point in_minor): Creates a new ellipse geometry in this segment and returns a key to it.

HPS.EllipticalArcKey InsertEllipticalArc (HPS.EllipticalArcKit in_kit): Creates a new elliptical arc geometry in this segment and returns a key to it.

HPS.EllipticalArcKey InsertEllipticalArc (HPS.Point in_center, HPS.Point in_major, HPS.Point in_minor, float in_start, float in_end): Creates a new elliptical arc geometry in this segment and returns a key to it.

HPS.GridKey InsertGrid (HPS.GridKit in_kit): Creates a new grid in this segment and returns a key to it.

HPS.GridKey InsertGrid (HPS.Point in_origin): Creates a new grid in this segment and returns a key to it.

HPS.GridKey InsertGrid (HPS.Point in_origin, HPS.Point in_first_point): Creates a new grid in this segment and returns a key to it.

HPS.GridKey InsertGrid (HPS.Point in_origin, HPS.Point in_first_point, HPS.Point in_second_point): Creates a new grid in this segment and returns a key to it.

HPS.GridKey InsertGrid (HPS.Point in_origin, HPS.Point in_first_point, HPS.Point in_second_point, int in_first_count): Creates a new grid in this segment and returns a key to it.

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): Creates a new grid in this segment and returns a key to it.

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): Creates a new grid in this segment and returns a key to it.

HPS.InfiniteLineKey InsertInfiniteLine (HPS.InfiniteLineKit in_kit): Creates a new infinite line geometry in this segment and returns a key to it.

HPS.InfiniteLineKey InsertInfiniteLine (HPS.Point in_first, HPS.Point in_second, HPS.InfiniteLine.Type in_type): Creates a new infinite line geometry in this segment and returns a key to it.

HPS.LineKey InsertLine (HPS.LineKit in_kit): Creates a new line geometry in this segment and returns a key to it.

HPS.LineKey InsertLine (HPS.Point pt1, HPS.Point pt2): Creates a new line geometry in this segment and returns a key to it.

HPS.LineKey InsertLine (HPS.Point[] in_pts): Creates a new line geometry in this segment and returns a key to it.

HPS.LineKey InsertLineFromGeometry (HPS.CircleKey in_circle)

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

Param in_circle: The CircleKey that will be used to compute the line approximation.
Return: The reference to the newly created line. Will have a type of Type.None if line insertion failed.

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

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

Param in_circle: The CircleKey that will be used to compute the line approximation.
Param in_deviation: The 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.
Return: The reference to the newly created line. Will have a type of Type.None if line insertion failed.

HPS.LineKey InsertLineFromGeometry (HPS.CircularArcKey in_circular_arc)

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

Param in_circular_arc: The CircularArcKey that will be used to compute the line approximation.
Return: The reference to the newly created line. Will have a type of Type.None if line insertion failed.

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

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

Param in_circular_arc: The CircularArcKey that will be used to compute the line approximation.
Param in_deviation: The 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.
Return: The reference to the newly created line. Will have a type of Type.None if line insertion failed.

HPS.LineKey InsertLineFromGeometry (HPS.CircularWedgeKey in_circular_wedge)

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

Param in_circular_wedge: The CircularWedgeKey that will be used to compute the line approximation.
Return: The reference to the newly created line. Will have a type of Type.None if line insertion failed.

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

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

Param in_circular_wedge: The CircularWedgeKey that will be used to compute the line approximation.
Param in_deviation: The 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.
Return: The reference to the newly created line. Will have a type of Type.None if line insertion failed.

HPS.LineKey InsertLineFromGeometry (HPS.EllipseKey in_ellipse)

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

Param in_ellipse: The EllipseKey that will be used to compute the line approximation.
Return: The reference to the newly created line. Will have a type of Type.None if line insertion failed.

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

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

Param in_ellipse: The EllipseKey that will be used to compute the line approximation.
Param in_deviation: The 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.
Return: The reference to the newly created line. Will have a type of Type.None if line insertion failed.

HPS.LineKey InsertLineFromGeometry (HPS.EllipticalArcKey in_elliptical_arc)

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

Param in_elliptical_arc: The EllipticalArcKey that will be used to compute the line approximation.
Return: The reference to the newly created line. Will have a type of Type.None if line insertion failed.

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

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

Param in_elliptical_arc: The EllipticalArcKey that will be used to compute the line approximation.
Param in_deviation: The 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.
Return: The reference to the newly created line. Will have a type of Type.None if line insertion failed.

HPS.LineKey InsertLineFromGeometry (HPS.NURBSCurveKey in_nurbs_curve)

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

Param in_nurbs_curve: The NURBSCurveKey that will be used to compute the line approximation.
Return: The reference to the newly created line. Will have a type of Type.None if line insertion failed.

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

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

Param in_nurbs_curve: The NURBSCurveKey that will be used to compute the line approximation.
Param in_deviation: The 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.
Return: The reference to the newly created line. Will have a type of Type.None if line insertion failed.

HPS.MarkerKey InsertMarker (HPS.MarkerKit in_kit): Creates a new marker geometry in this segment and returns a key to it.

HPS.MarkerKey InsertMarker (HPS.Point in_position): Creates a new marker geometry in this segment and returns a key to it.

HPS.MeshKey InsertMesh (HPS.MeshKit in_kit): Creates a new mesh geometry in this segment and returns a key to it.

HPS.MeshKey InsertMesh (ulong in_rows, ulong in_columns, HPS.Point[] in_points): Creates a new mesh geometry in this segment and returns a key to it.

HPS.NURBSCurveKey InsertNURBSCurve (HPS.NURBSCurveKit in_kit): Creates a new NURBS curve geometry in this segment and returns a key to it.

HPS.NURBSCurveKey InsertNURBSCurve (ulong in_degree, HPS.Point[] in_points, float[] in_weights, float[] in_knots, float in_start_u, float in_end_u): Creates a new NURBS curve geometry in this segment and returns a key to it.

HPS.NURBSSurfaceKey InsertNURBSSurface (HPS.NURBSSurfaceKit in_kit): Creates a new NURBS surface geometry in this segment and returns a key to it.

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): Creates a new NURBS surface geometry in this segment and returns a key to it.

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): Creates a new NURBS surface geometry in this segment and returns a key to it.

HPS.PolygonKey InsertPolygon (HPS.Point[] in_points): Creates a new polygon geometry in this segment and returns a key to it.

HPS.PolygonKey InsertPolygon (HPS.PolygonKit in_kit): Creates a new polygon geometry in this segment and returns a key to it.

HPS.ShellKey InsertShell (HPS.Point[] in_points, int[] in_facelist): Creates a new shell geometry in this segment and returns a key to it.

HPS.ShellKey InsertShell (HPS.ShellKit in_kit): Creates a new shell geometry in this segment and returns a key to it.

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

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

Param in_points: An array of HPS.Point that will serve as vertices in the tri-strip.
Param in_tristrips: An 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 };

HPS.ShellKey InsertShellFromGeometry (HPS.CircleKey in_circle)

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

Param in_circle: The CircleKey that will be used to compute the shell approximation.
Return: The reference to the newly created shell. Will have a type of Type.None if shell insertion failed.

HPS.ShellKey InsertShellFromGeometry (HPS.CircularWedgeKey in_circular_wedge)

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

Param in_circular_wedge: The CircularWedgeKey that will be used to compute the shell approximation.
Return: The reference to the newly created shell. Will have a type of Type.None if shell insertion failed.

HPS.ShellKey InsertShellFromGeometry (HPS.CylinderKey in_cylinder)

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

Param in_cylinder: The CylinderKey that will be used to compute the shell approximation.
Return: The reference to the newly created shell. Will have a type of Type.None if shell insertion failed.

HPS.ShellKey InsertShellFromGeometry (HPS.EllipseKey in_ellipse)

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

Param in_ellipse: The EllipseKey that will be used to compute the shell approximation.
Return: The reference to the newly created shell. Will have a type of Type.None if shell insertion failed.

HPS.ShellKey InsertShellFromGeometry (HPS.MeshKey in_mesh)

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

Param in_mesh: The MeshKey that will be used to compute the shell approximation.
Return: The reference to the newly created shell. Will have a type of Type.None if shell insertion failed.

HPS.ShellKey InsertShellFromGeometry (HPS.NURBSSurfaceKey in_nurbs_surface)

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

Param in_nurbs_surface: The NURBSSurfaceKey that will be used to compute the shell approximation.
Return: The reference to the newly created shell. Will have a type of Type.None if shell insertion failed.

HPS.ShellKey InsertShellFromGeometry (HPS.PolygonKey in_polygon)

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

Param in_polygon: The PolygonKey that will be used to compute the shell approximation.
Return: The reference to the newly created shell. Will have a type of Type.None if shell insertion failed.

HPS.ShellKey InsertShellFromGeometry (HPS.SphereKey in_sphere)

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

Param in_sphere: The SphereKey that will be used to compute the shell approximation.
Return: The reference to the newly created shell. Will have a type of Type.None if shell insertion failed.

HPS.ShellKey InsertShellFromGeometry (HPS.TextKey in_text)

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.

Param in_text: The TextKey that will be used to compute the shell approximation.
Return: The reference to the newly created shell. Will have a type of Type.None if shell insertion failed.

HPS.SphereKey InsertSphere (HPS.Point in_center, float in_radius)

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

Param in_center: The Point that will define the center of the sphere
Param in_radius: The radius of the sphere
Return: The reference to the newly created sphere. Will have a type of Type.None if sphere insertion failed

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

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

Param in_center: The Point that will define the center of the sphere
Param in_radius: The radius of the sphere
Param in_axis: The Vector that will define the axis of the sphere
Return: The reference to the newly created sphere. Will have a type of Type.None if sphere insertion failed

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

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

Param in_center: The Point that will define the center of the sphere
Param in_radius: The radius of the sphere
Param in_axis: The Vector that will define the axis of the sphere
Param in_prime_meridian: The Vector that will define the orientation of the sphere (as rotated on its axis)
Return: The reference to the newly created sphere. Will have a type of Type.None if sphere insertion failed

HPS.SphereKey InsertSphere (HPS.SphereKit in_kit)

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

Param in_kit: The SphereKit that will define the sphere
Return: The reference to the newly created sphere. Will have a type of Type.None if sphere insertion failed

HPS.SpotlightKey InsertSpotlight (HPS.Point in_position, HPS.Point in_target): Creates a new spot light geometry in this segment and returns a key to it.

HPS.SpotlightKey InsertSpotlight (HPS.SpotlightKit in_kit): Creates a new spot light geometry in this segment and returns a key to it.

HPS.TextKey InsertText (HPS.Point in_position, string in_text)

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

Param in_position: The position, in world coordinates, where the text will be inserted.
Param in_text: The text UTF-8 encoded string to insert.
Return: A reference to the newly created TextKey object. Will have a type of Type.None if line insertion failed.

HPS.TextKey InsertText (HPS.TextKit in_kit): Creates a new text geometry in this segment and returns a key to it.

string Name (): Returns the name given to this segment when it was created.

override HPS.Type ObjectType ()

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).

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

void Optimize (HPS.SegmentOptimizationOptionsKit in_kit)

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

Param in_kit: A SegmentOptimizationOptionsKit that specifies how the Segment should be optimized.

HPS.OptimizeMappingResults OptimizeWithMapping (HPS.SegmentOptimizationOptionsKit in_kit)

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.

Param in_kit: A SegmentOptimizationOptionsKit that specifies how the Segment should be optimized.
Return: OptimizeMappingResults with information about merged shells.

HPS.ReferenceKey ReferenceGeometry (HPS.Key in_key)

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).

Param in_key: A key to either a piece of geometry or a segment.
Return: A reference to the newly created geometry reference. This will have a type of Type.None if geometry reference creation failed.

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

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.

Param in_key: A key to either a piece of geometry or a segment.
Param in_conditional: A conditional expression which will determine whether the referenced geometry gets drawn for this segment.
Return: A reference to the newly created geometry reference. This will have a type of Type.None if geometry reference creation failed.

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

SegmentKey (HPS.Key in_that): 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.

SegmentKey (HPS.SegmentKey in_that): Shares a reference to a database object referred to by in_that.

HPS.SegmentKey SetAttributeLock (HPS.AttributeLockKit in_kit): Sets the attribute locks designated by in_kit on this segment.

HPS.SegmentKey SetBounding (HPS.BoundingKit in_kit): Sets the bounding designated by in_kit on this segment.

HPS.SegmentKey SetCamera (HPS.CameraKit in_kit): Sets the camera attribute designated by in_kit on this segment.

HPS.SegmentKey SetColorInterpolation (HPS.ColorInterpolationKit in_kit): Sets the color interpolation attributes designated by in_kit on this segment.

HPS.SegmentKey SetCondition (string in_condition): Sets in_condition as the only condition on this segment, replacing any existing conditions.

HPS.SegmentKey SetConditions (string[] in_conditions): Sets in_conditions as the only conditions on this segment, replacing any existing conditions.

HPS.SegmentKey SetContourLine (HPS.ContourLineKit in_kit): Sets the contour line attributes designated by in_kit on this segment.

HPS.SegmentKey SetCulling (HPS.CullingKit in_kit): Sets the culling attributes designated by in_kit on this segment.

HPS.SegmentKey SetCurveAttribute (HPS.CurveAttributeKit in_kit): Sets the curve attributes designated by in_kit on this segment.

HPS.SegmentKey SetCuttingSectionAttribute (HPS.CuttingSectionAttributeKit in_kit): Sets the cutting section attributes designated by in_kit on this segment.

HPS.SegmentKey SetCylinderAttribute (HPS.CylinderAttributeKit in_kit): Sets the cylinder attributes designated by in_kit on this segment.

HPS.SegmentKey SetDrawingAttribute (HPS.DrawingAttributeKit in_kit): Sets the drawing attributes designated by in_kit on this segment.

HPS.SegmentKey SetEdgeAttribute (HPS.EdgeAttributeKit in_kit): Sets the edge attributes designated by in_kit on this segment.

HPS.SegmentKey SetHiddenLineAttribute (HPS.HiddenLineAttributeKit in_kit): Sets the hidden line attributes designated by in_kit on this segment.

HPS.SegmentKey SetLightingAttribute (HPS.LightingAttributeKit in_kit): Sets the lighting attributes designated by in_kit on this segment.

HPS.SegmentKey SetLineAttribute (HPS.LineAttributeKit in_kit): Sets the line attributes designated by in_kit on this segment.

HPS.SegmentKey SetMarkerAttribute (HPS.MarkerAttributeKit in_kit): Sets the marker attributes designated by in_kit on this segment.

HPS.SegmentKey SetMaterialMapping (HPS.MaterialMappingKit in_kit): Sets the material mappings designated by in_kit on this segment.

HPS.SegmentKey SetMaterialPalette (string in_name): Applies the material palette associated with in_name to this segment, replacing any existing material palette.

HPS.SegmentKey SetModellingMatrix (HPS.MatrixKit in_kit): Sets the modelling matrix attributes designated by in_kit on this segment.

HPS.SegmentKey SetName (string in_name)

Sets the new name of this segment.

Return: A reference to this key

HPS.SegmentKey SetNURBSSurfaceAttribute (HPS.NURBSSurfaceAttributeKit in_kit): Sets the NURBS surface attributes designated by in_kit on this segment.

HPS.SegmentKey SetPBRMaterial (HPS.PBRMaterialKit in_kit): Sets a PBR material designated by in_kit on this segment.

HPS.SegmentKey SetPerformance (HPS.PerformanceKit in_kit): Sets the performance attributes designated by in_kit on this segment.

HPS.SegmentKey SetPriority (int in_priority)

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.

See: SubwindowKit.SetRenderingAlgorithm()

Param in_priority: The drawing priority, higher priority items are drawn on top of lower priority items.
Return: A reference to this object.

HPS.SegmentKey SetSelectability (HPS.SelectabilityKit in_kit): Sets the selectability attributes designated by in_kit on this segment.

HPS.SegmentKey SetSphereAttribute (HPS.SphereAttributeKit in_kit): Sets the sphere attributes designated by in_kit on this segment.

HPS.SegmentKey SetSubwindow (HPS.SubwindowKit in_kit): Sets the subwindow attributes designated by in_kit on this segment.

HPS.SegmentKey SetTextAttribute (HPS.TextAttributeKit in_kit): Sets the text attributes designated by in_kit on this segment.

HPS.SegmentKey SetTextureMatrix (HPS.MatrixKit in_kit): Sets the texture matrix attributes designated by in_kit on this segment.

HPS.SegmentKey SetTransformMask (HPS.TransformMaskKit in_kit): Sets the transform mask designated by in_kit on this segment.

HPS.SegmentKey SetTransparency (HPS.TransparencyKit in_kit): Sets the transparency attributes designated by in_kit on this segment.

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

Sets user data on this key.

Param in_index: The index of the user data to set.
Param in_data: The bytes of user data to set.
Return: A reference to this key.

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

Sets user data on this key.

Param in_index: The index of the user data to set.
Param in_bytes: The number of bytes of user data to set.
Param in_data: The bytes of user data to set.
Return: A reference to this key.

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

Sets user data on this key.

Param in_indices: An array of user data indices to set.
Param in_data: An array of bytes of user data to set.
Return: A reference to this key.

HPS.SegmentKey SetVisibility (HPS.VisibilityKit in_kit): Sets the visibility attribute designated by in_kit on this segment.

HPS.SegmentKey SetVisualEffects (HPS.VisualEffectsKit in_kit): Sets the visual effects attributes designated by in_kit on this segment.

bool ShowAttributeLock (out HPS.AttributeLockKit out_kit)

Shows the attribute locks settings on this segment.

Return: False if no attribute locks settings exist on this segment.

bool ShowBounding (out HPS.BoundingKit out_kit)

Shows the bounding or bounding settings on this segment.

Return: False if no bounding or bounding settings on this segment.

bool ShowCamera (out HPS.CameraKit out_kit): Shows the camera attribute settings on this segment. Returns false if no camera is set on this segment.

bool ShowColorInterpolation (out HPS.ColorInterpolationKit out_kit): Shows the color interpolation attribute settings on this segment. Returns false if no color interpolation attribute settings exist on this segment.

bool ShowConditions (out string[] out_conditions)

bool ShowContourLine (out HPS.ContourLineKit out_kit): Shows the contour line attribute settings on this segment. Returns false if no contour line attribute settings exist on this segment.

bool ShowCulling (out HPS.CullingKit out_kit)

Shows the culling attribute settings on this segment.

Return: False if no culling attribute settings exist on this segment.

bool ShowCurveAttribute (out HPS.CurveAttributeKit out_kit): Shows the curve attribute settings on this segment. Returns false if no curve attribute settings exist on this segment.

bool ShowCuttingSectionAttribute (out HPS.CuttingSectionAttributeKit out_kit): Shows the cutting section attribute settings on this segment. Returns false if no cutting section attribute settings exist on this segment.

bool ShowCylinderAttribute (out HPS.CylinderAttributeKit out_kit): Shows the cylinder attribute settings on this segment. Returns false if no cylinder attribute settings exist on this segment.

bool ShowDrawingAttribute (out HPS.DrawingAttributeKit out_kit): Shows the drawing attribute settings on this segment. Returns false if no drawing settings exist on this segment.

bool ShowEdgeAttribute (out HPS.EdgeAttributeKit out_kit): Shows the edge attribute settings on this segment. Returns false if no edge attribute settings exist on this segment.

bool ShowHiddenLineAttribute (out HPS.HiddenLineAttributeKit out_kit): Shows the hidden line attribute settings on this segment. Returns false if no hidden line settings exist on this segment.

ulong ShowIncluders (out HPS.IncludeKey[] out_includes)

Shows the all the includes of this key.

Param out_includes: The list of all includes of this key.
Return: The number of includes of this key.

ulong ShowIncluders (out HPS.SegmentKey[] out_segments)

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

Param out_segments: The list of segments which contains includes of this key.
Return: The number of segments which contain includes of this key.

bool ShowLightingAttribute (out HPS.LightingAttributeKit out_kit): Shows the lighting attribute settings on this segment. Returns false if no lighting attribute settings exist on this segment.

bool ShowLineAttribute (out HPS.LineAttributeKit out_kit): Shows the line attribute settings on this segment. Returns false if no line attribute settings exist on this segment.

bool ShowMarkerAttribute (out HPS.MarkerAttributeKit out_kit): Shows the marker attribute settings on this segment. Returns false if no marker attribute settings exist on this segment.

bool ShowMaterialMapping (out HPS.MaterialMappingKit out_kit): Shows the material mapping settings on this segment. Returns false if no material mapping settings exist on this segment.

bool ShowMaterialPalette (out string out_name): Shows the existing material palette, if any, that is active on this segment.

bool ShowModellingMatrix (out HPS.MatrixKit out_kit): Shows the modelling matrix setting on this segment. Returns false if no modelling matrix setting exists on this segment.

bool ShowNURBSSurfaceAttribute (out HPS.NURBSSurfaceAttributeKit out_kit): Shows the NURBS surface attribute settings on this segment. Returns false if no NURBS surface attribute settings exist on this segment.

bool ShowPBRMaterial (out HPS.PBRMaterialKit out_kit): Shows the PBR material settings on this segment. Returns false if no PBR material settings exist on this segment.

bool ShowPerformance (out HPS.PerformanceKit out_kit): Shows the performance attribute settings on this segment. Returns false if no performance settings exist on this segment.

bool ShowPriority (out int out_priority)

Shows the drawing priority.

Param out_priority: The drawing priority, higher priority items are drawn on top of lower priority items.
Return: true if a priority was specified, false otherwise.

ulong ShowReferrers (out HPS.ReferenceKey[] out_references)

Shows the all the references to this key.

Param out_references: The list of all references to this key.
Return: The number of references to this key.

ulong ShowReferrers (out HPS.SegmentKey[] out_segments)

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.

Param out_segments: The list of segments which contains references to this key.
Return: The number of segments which contain references to this key.

bool ShowSelectability (out HPS.SelectabilityKit out_kit)

Shows the selectability attribute settings on this segment.

Return: False if no selectability settings exist on this segment.

bool ShowSphereAttribute (out HPS.SphereAttributeKit out_kit)

Shows the sphere attribute settings on this segment.

Return: False if no sphere attribute settings exist on this segment.

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

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.

Param out_segments: The list of segments which are styled by this key.
Return: The number of segments which are styled by this key.

ulong ShowStylers (out HPS.StyleKey[] out_styles)

Shows the all the styles which refer to this key.

Param out_styles: The list of all styles which refer to this key.
Return: The number of styles which refer to this key.

ulong ShowSubsegments ()

return: A count of all child segments of this segment

ulong ShowSubsegments (out HPS.SegmentKey[] out_children)

return: A count of all child segments of this segment and populates out_children with keys to them.

bool ShowSubwindow (out HPS.SubwindowKit out_kit)

Shows the subwindow attribute settings on this segment.

Return: False if no subwindow attribute settings exist on this segment.

bool ShowTextAttribute (out HPS.TextAttributeKit out_kit): Shows the text attribute settings on this segment. Returns false if no text attribute settings exist on this segment.

bool ShowTextureMatrix (out HPS.MatrixKit out_kit)

Shows the texture matrix setting on this segment.

Return: False if no texture matrix setting exists on this segment.

bool ShowTransformMask (out HPS.TransformMaskKit out_kit)

Shows the transform mask settings on this segment.

Return: False if no bounding settings exist on this segment.

bool ShowTransparency (out HPS.TransparencyKit out_kit)

Shows the transparency attribute settings on this segment.

Return: False if no transparency attribute settings exist on this segment.

bool ShowUserData (IntPtr in_index, out byte[] out_data)

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

Param in_index: The index of the user data to show.
Param out_data: The user data at the given index.
Return: true if there is user data at the given index, false otherwise.

bool ShowUserData (out IntPtr[] out_indices, out byte[][] out_data)

Shows all user data for this key.

Param out_indices: An array of all user data indices set on this key.
Param out_data: An array of all user data set on this key.
Return: true if there is user data on this key, false otherwise.

ulong ShowUserDataCount (): Get the number of user data indices set on this key.

bool ShowUserDataIndices (out IntPtr[] out_indices)

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

Param out_indices: The user data indices set on this key.
Return: The number of user data indices set on this key.

bool ShowVisibility (out HPS.VisibilityKit out_kit)

Shows the visibility attribute settings on this segment.

Return: False if no visibility is set on this segment.

bool ShowVisualEffects (out HPS.VisualEffectsKit out_kit)

Shows the visual effects attribute settings on this segment.

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

HPS.SegmentKey Subsegment (): 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.

HPS.SegmentKey Subsegment (string in_segment_name): 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.

HPS.SegmentKey Subsegment (string in_segment_name, bool in_create_if_not_present): 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.

HPS.SegmentKey UnsetAllUserData ()

Removes all user data from this key.

Return: A reference to this key.

HPS.SegmentKey UnsetAttributeLock (): Removes all attribute locks settings from this segment.

HPS.SegmentKey UnsetBounding (): Removes all bounding settings from this segment.

HPS.SegmentKey UnsetCamera (): Removes any camera set on this segment.

HPS.SegmentKey UnsetColorInterpolation (): Removes any color interpolation attributes set on this segment.

HPS.SegmentKey UnsetConditions (): Unsets all conditions on this segment.

HPS.SegmentKey UnsetContourLine (): Removes any contour line attributes set on this segment.

HPS.SegmentKey UnsetCulling (): Removes all culling attribute settings from this segment.

HPS.SegmentKey UnsetCurveAttribute (): Removes all curve attribute settings from this segment.

HPS.SegmentKey UnsetCuttingSectionAttribute (): Removes all cutting section attribute settings from this segment.

HPS.SegmentKey UnsetCylinderAttribute (): Removes all cylinder attribute settings from this segment.

HPS.SegmentKey UnsetDrawingAttribute (): Removes all drawing settings from this segment.

HPS.SegmentKey UnsetEdgeAttribute (): Removes all edge attribute settings from this segment.

HPS.SegmentKey UnsetHiddenLineAttribute (): Removes all hidden line settings from this segment.

HPS.SegmentKey UnsetLightingAttribute (): Removes all lighting attribute settings from this segment.

HPS.SegmentKey UnsetLineAttribute (): Removes all line attribute settings from this segment.

HPS.SegmentKey UnsetMarkerAttribute (): Removes all marker attribute settings from this segment.

HPS.SegmentKey UnsetMaterialMapping (): Removes all material mapping settings from this segment.

HPS.SegmentKey UnsetMaterialPalette (): Removes the existing material palette, if any, that is active on this segment.

HPS.SegmentKey UnsetModellingMatrix (): Removes any modelling matrix settings from this segment.

HPS.SegmentKey UnsetNURBSSurfaceAttribute (): Removes all NURBS surface attribute settings from this segment.

HPS.SegmentKey UnsetPBRMaterial (): Removes all PBR material settings from this segment.

HPS.SegmentKey UnsetPerformance (): Removes all performance settings from this segment.

HPS.SegmentKey UnsetPriority ()

Removes the drawing priority setting.

Return: A reference to this object.

HPS.SegmentKey UnsetSelectability (): Removes all selectability settings from this segment.

HPS.SegmentKey UnsetSphereAttribute (): Removes all sphere attribute settings from this segment.

HPS.SegmentKey UnsetSubwindow (): Removes all subwindow attribute settings from this segment.

HPS.SegmentKey UnsetTextAttribute (): Removes all text attribute settings from this segment.

HPS.SegmentKey UnsetTextureMatrix (): Removes any texture matrix settings from this segment.

HPS.SegmentKey UnsetTransformMask (): Removes all transform mask settings from this segment.

HPS.SegmentKey UnsetTransparency (): Removes all transparency attribute settings from this segment.

HPS.SegmentKey UnsetUserData (IntPtr in_index)

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

Param in_index: The index of the user data to remove.
Return: A reference to this key.

HPS.SegmentKey UnsetUserData (IntPtr[] in_indices)

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

Param in_indices: The indices of the user data to remove.
Return: A reference to this key.

HPS.SegmentKey UnsetVisibility (): Removes all visibility settings from this segment.

HPS.SegmentKey UnsetVisualEffects (): Removes all visual effects attribute settings from this segment.