
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static bool | operator!= (HPS.Key a, HPS.Key b) |
static bool | operator== (HPS.Key a, HPS.Key b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
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]
|
inline |
An uninitialized key refers to no database object and Type() will return Type.None.
◆ SegmentKey() [2/3]
|
inline |
Shares a reference to a database object referred to by in_that.
◆ SegmentKey() [3/3]
|
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]
|
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]
|
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]
|
inline |
Searches in_search_space for in_request and returns a handle to the results.
◆ Find() [2/4]
|
inline |
Searches in_search_space for in_request and returns a handle to the results.
◆ Find() [3/4]
|
inline |
Searches starting at this segment using in_options and writes found objects into out_results, returns count.
◆ Find() [4/4]
|
inline |
Searches starting at this segment using in_options, returns count.
◆ Flush() [1/5]
|
inline |
Searches in_search_space for in_type_to_remove and deletes all instances from the segment(s).
◆ Flush() [2/5]
|
inline |
Searches in_search_space for in_type_to_remove and deletes all instances from the segment(s).
◆ Flush() [3/5]
|
inline |
Searches in_search_space for in_type_to_remove and deletes all instances from the segment(s).
◆ Flush() [4/5]
|
inline |
Searches in_search_space for in_types_to_remove and deletes all instances from the segment(s).
◆ Flush() [5/5]
|
inline |
Searches in_search_space for in_types_to_remove and deletes all instances from the segment(s).
◆ GetAttributeLockControl()
|
inline |
Returns a control that allows the user to manipulate and query details of the attribute locks on this segment.
◆ GetBoundingControl()
|
inline |
Returns a control that allows the user to manipulate and query details of the bounding control on this segment.
◆ GetCullingControl()
|
inline |
Returns a control that allows the user to manipulate and query details of the culling attribute on this segment.
◆ GetCurveAttributeControl()
|
inline |
Returns a control that allows the user to manipulate and query details of the curve attribute on this segment.
◆ GetCuttingSectionAttributeControl()
|
inline |
Returns a control that allows the user to manipulate and query details of the cutting section attributes on this segment.
◆ GetCylinderAttributeControl()
|
inline |
Returns a control that allows the user to manipulate and query details of the cylinder attribute on this segment.
◆ GetDrawingAttributeControl()
|
inline |
Returns a control that allows the user to manipulate and query details of the drawing attribute on this segment.
◆ GetEdgeAttributeControl()
|
inline |
Returns a control that allows the user to manipulate and query details of the edge attribute on this segment.
◆ GetHiddenLineAttributeControl()
|
inline |
Returns a control that allows the user to manipulate and query details of the hidden line attribute on this segment.
◆ GetLightingAttributeControl()
|
inline |
Returns a control that allows the user to manipulate and query details of the lighting attribute on this segment.
◆ GetLineAttributeControl()
|
inline |
Returns a control that allows the user to manipulate and query details of the line attribute on this segment.
◆ GetMarkerAttributeControl()
|
inline |
Returns a control that allows the user to manipulate and query details of the marker attribute on this segment.
◆ GetMaterialMappingControl()
|
inline |
Returns a control that allows the user to manipulate and query details of the material mapping on this segment.
◆ GetModellingMatrixControl()
|
inline |
Returns a control that allows the user to manipulate and query details of the modelling matrix on this segment.
◆ GetNURBSSurfaceAttributeControl()
|
inline |
Returns a control that allows the user to manipulate and query details of the NURBS surface attribute on this segment.
◆ GetPerformanceControl()
|
inline |
Returns a control that allows the user to manipulate and query details of the performance attribute on this segment.
◆ GetSelectabilityControl()
|
inline |
Returns a control that allows the user to manipulate and query details of the selectability attribute on this segment.
◆ GetSphereAttributeControl()
|
inline |
Returns a control that allows the user to manipulate and query details of the sphere attribute on this segment.
◆ GetSubwindowControl()
|
inline |
Returns a control that allows the user to manipulate and query details of the subwindow attribute on this segment.
◆ GetTextAttributeControl()
|
inline |
Returns a control that allows the user to manipulate and query details of the text attribute on this segment.
◆ GetTextureMatrixControl()
|
inline |
Returns a control that allows the user to manipulate and query details of the texture matrix on this segment.
◆ GetTransformMaskControl()
|
inline |
Returns a control that allows the user to manipulate and query details of the transform mask on this segment.
◆ GetTransparencyControl()
|
inline |
Returns a control that allows the user to manipulate and query details of the transparency attribute on this segment.
◆ GetVisibilityControl()
|
inline |
Returns a control that allows the user to manipulate and query details of the visibility attribute on this segment.
◆ 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]
|
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]
|
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]
|
inline |
Creates a new circle geometry in this segment and returns a key to it.
◆ InsertCircle() [2/3]
|
inline |
Creates a new circle geometry in this segment and returns a key to it.
◆ InsertCircle() [3/3]
|
inline |
Creates a new circle geometry in this segment and returns a key to it.
◆ InsertCircularArc() [1/2]
|
inline |
Creates a new circular arc geometry in this segment and returns a key to it.
◆ InsertCircularArc() [2/2]
|
inline |
Creates a new circular arc geometry in this segment and returns a key to it.
◆ InsertCircularWedge() [1/2]
|
inline |
Creates a new circular wedge geometry in this segment and returns a key to it.
◆ InsertCircularWedge() [2/2]
|
inline |
Creates a new circular wedge geometry in this segment and returns a key to it.
◆ InsertCuttingSection() [1/3]
|
inline |
Creates a new cutting section in this segment and returns a key to it.
◆ InsertCuttingSection() [2/3]
|
inline |
Creates a new cutting section in this segment and returns a key to it.
◆ InsertCuttingSection() [3/3]
|
inline |
Creates a new cutting section in this segment and returns a key to it.
◆ InsertCylinder() [1/5]
|
inline |
Creates a new cylinder geometry in this segment and returns a key to it.
◆ InsertCylinder() [2/5]
|
inline |
Creates a new cylinder geometry in this segment and returns a key to it.
◆ InsertCylinder() [3/5]
|
inline |
Creates a new cylinder geometry in this segment and returns a key to it.
◆ InsertCylinder() [4/5]
|
inline |
Creates a new cylinder geometry in this segment and returns a key to it.
◆ InsertCylinder() [5/5]
|
inline |
Creates a new cylinder geometry in this segment and returns a key to it.
◆ InsertDistantLight() [1/2]
|
inline |
Creates a new distant light geometry in this segment and returns a key to it.
◆ InsertDistantLight() [2/2]
|
inline |
Creates a new distant light geometry in this segment and returns a key to it.
◆ InsertEllipse() [1/2]
|
inline |
Creates a new ellipse geometry in this segment and returns a key to it.
◆ InsertEllipse() [2/2]
|
inline |
Creates a new ellipse geometry in this segment and returns a key to it.
◆ InsertEllipticalArc() [1/2]
|
inline |
Creates a new elliptical arc geometry in this segment and returns a key to it.
◆ InsertEllipticalArc() [2/2]
|
inline |
Creates a new elliptical arc geometry in this segment and returns a key to it.
◆ InsertGrid() [1/7]
|
inline |
Creates a new grid in this segment and returns a key to it.
◆ InsertGrid() [2/7]
|
inline |
Creates a new grid in this segment and returns a key to it.
◆ InsertGrid() [3/7]
|
inline |
Creates a new grid in this segment and returns a key to it.
◆ InsertGrid() [4/7]
|
inline |
Creates a new grid in this segment and returns a key to it.
◆ InsertGrid() [5/7]
|
inline |
Creates a new grid in this segment and returns a key to it.
◆ InsertGrid() [6/7]
|
inline |
Creates a new grid in this segment and returns a key to it.
◆ InsertGrid() [7/7]
|
inline |
Creates a new grid in this segment and returns a key to it.
◆ InsertInfiniteLine() [1/2]
|
inline |
Creates a new infinite line geometry in this segment and returns a key to it.
◆ InsertInfiniteLine() [2/2]
|
inline |
Creates a new infinite line geometry in this segment and returns a key to it.
◆ InsertLine() [1/3]
|
inline |
Creates a new line geometry in this segment and returns a key to it.
◆ InsertLine() [2/3]
|
inline |
Creates a new line geometry in this segment and returns a key to it.
◆ InsertLine() [3/3]
|
inline |
Creates a new line geometry in this segment and returns a key to it.
◆ InsertLineFromGeometry() [1/12]
|
inline |
Creates a new line geometry in this segment which approximates the given circle and returns a key to it.
- Parameters
-
in_circle The CircleKey that will be used to compute the line approximation. 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.
- Returns
- The reference to the newly created line. Will have a type of Type.None if line insertion failed.
◆ InsertLineFromGeometry() [2/12]
|
inline |
Creates a new line geometry in this segment which approximates the given circle and returns a key to it.
- Parameters
-
in_circle The 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]
|
inline |
Creates a new line geometry in this segment which approximates the given circular arc and returns a key to it.
- Parameters
-
in_circular_arc The CircularArcKey that will be used to compute the line approximation. 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.
- Returns
- The reference to the newly created line. Will have a type of Type.None if line insertion failed.
◆ InsertLineFromGeometry() [4/12]
|
inline |
Creates a new line geometry in this segment which approximates the given circular arc and returns a key to it.
- Parameters
-
in_circular_arc The 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]
|
inline |
Creates a new line geometry in this segment which approximates the given circular wedge and returns a key to it.
- Parameters
-
in_circular_wedge The CircularWedgeKey that will be used to compute the line approximation. 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.
- Returns
- The reference to the newly created line. Will have a type of Type.None if line insertion failed.
◆ InsertLineFromGeometry() [6/12]
|
inline |
Creates a new line geometry in this segment which approximates the given circular wedge and returns a key to it.
- Parameters
-
in_circular_wedge The 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]
|
inline |
Creates a new line geometry in this segment which approximates the given ellipse and returns a key to it.
- Parameters
-
in_ellipse The EllipseKey that will be used to compute the line approximation. 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.
- Returns
- The reference to the newly created line. Will have a type of Type.None if line insertion failed.
◆ InsertLineFromGeometry() [8/12]
|
inline |
Creates a new line geometry in this segment which approximates the given ellipse and returns a key to it.
- Parameters
-
in_ellipse The 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]
|
inline |
Creates a new line geometry in this segment which approximates the given elliptical arc and returns a key to it.
- Parameters
-
in_elliptical_arc The EllipticalArcKey that will be used to compute the line approximation. 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.
- Returns
- The reference to the newly created line. Will have a type of Type.None if line insertion failed.
◆ InsertLineFromGeometry() [10/12]
|
inline |
Creates a new line geometry in this segment which approximates the given elliptical arc and returns a key to it.
- Parameters
-
in_elliptical_arc The 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]
|
inline |
Creates a new line geometry in this segment which approximates the given NURBS curve and returns a key to it.
- Parameters
-
in_nurbs_curve The NURBSCurveKey that will be used to compute the line approximation. 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.
- Returns
- The reference to the newly created line. Will have a type of Type.None if line insertion failed.
◆ InsertLineFromGeometry() [12/12]
|
inline |
Creates a new line geometry in this segment which approximates the given NURBS curve and returns a key to it.
- Parameters
-
in_nurbs_curve The 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]
|
inline |
Creates a new marker geometry in this segment and returns a key to it.
◆ InsertMarker() [2/2]
|
inline |
Creates a new marker geometry in this segment and returns a key to it.
◆ InsertMesh() [1/2]
|
inline |
Creates a new mesh geometry in this segment and returns a key to it.
◆ InsertMesh() [2/2]
|
inline |
Creates a new mesh geometry in this segment and returns a key to it.
◆ InsertNURBSCurve() [1/2]
|
inline |
Creates a new NURBS curve geometry in this segment and returns a key to it.
◆ InsertNURBSCurve() [2/2]
|
inline |
Creates a new NURBS curve geometry in this segment and returns a key to it.
◆ InsertNURBSSurface() [1/3]
|
inline |
Creates a new NURBS surface geometry in this segment and returns a key to it.
◆ InsertNURBSSurface() [2/3]
|
inline |
Creates a new NURBS surface geometry in this segment and returns a key to it.
◆ InsertNURBSSurface() [3/3]
|
inline |
Creates a new NURBS surface geometry in this segment and returns a key to it.
◆ InsertPolygon() [1/2]
|
inline |
Creates a new polygon geometry in this segment and returns a key to it.
◆ InsertPolygon() [2/2]
|
inline |
Creates a new polygon geometry in this segment and returns a key to it.
◆ InsertShell() [1/2]
|
inline |
Creates a new shell geometry in this segment and returns a key to it.
◆ InsertShell() [2/2]
|
inline |
Creates a new shell geometry in this segment and returns a key to it.
◆ InsertShellByTristrips()
|
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_points An array of HPS.Point that will serve as vertices in the tri-strip. 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 };
◆ InsertShellFromGeometry() [1/9]
|
inline |
Creates a new shell geometry in this segment which approximates the given sphere and returns a key to it.
- Parameters
-
in_sphere The 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]
|
inline |
Creates a new shell geometry in this segment which approximates the given cylinder and returns a key to it.
- Parameters
-
in_cylinder The 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]
|
inline |
Creates a new shell geometry in this segment which approximates the given NURBS surface and returns a key to it.
- Parameters
-
in_nurbs_surface The 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]
|
inline |
Creates a new shell geometry in this segment which approximates the given mesh and returns a key to it.
- Parameters
-
in_mesh The 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]
|
inline |
Creates a new shell geometry in this segment which approximates the given polygon and returns a key to it.
- Parameters
-
in_polygon The 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]
|
inline |
Creates a new shell geometry in this segment which approximates the given ellipse and returns a key to it.
- Parameters
-
in_ellipse The 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]
|
inline |
Creates a new shell geometry in this segment which approximates the given circle and returns a key to it.
- Parameters
-
in_circle The 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]
|
inline |
Creates a new shell geometry in this segment which approximates the given circular wedge and returns a key to it.
- Parameters
-
in_circular_wedge The 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]
|
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_text The 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]
|
inline |
Creates a new sphere geometry in this segment and returns a key to it.
- Parameters
-
in_kit The 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]
|
inline |
Creates a new sphere geometry in this segment and returns a key to it.
- Parameters
-
in_center The Point that will define the center of the sphere in_radius The radius of the sphere in_axis The Vector that will define the axis of the sphere in_prime_meridian The 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]
|
inline |
Creates a new sphere geometry in this segment and returns a key to it.
- Parameters
-
in_center The Point that will define the center of the sphere in_radius The radius of the sphere in_axis The 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]
|
inline |
Creates a new sphere geometry in this segment and returns a key to it.
- Parameters
-
in_center The Point that will define the center of the sphere in_radius The 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]
|
inline |
Creates a new spot light geometry in this segment and returns a key to it.
◆ InsertSpotlight() [2/2]
|
inline |
Creates a new spot light geometry in this segment and returns a key to it.
◆ InsertText() [1/2]
|
inline |
Creates a new text geometry in this segment and returns a key to it.
◆ InsertText() [2/2]
|
inline |
Creates a new text geometry in this segment and returns a key to it.
- Parameters
-
in_position The position, in world coordinates, where the text will be inserted. in_text The 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()
|
inline |
Returns the name given to this segment when it was created.
◆ 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()
|
inline |
Optimizes this Segment according to the options specified in the SegmentOptimizationOptionsKit.
- Parameters
-
in_kit A SegmentOptimizationOptionsKit that specifies how the Segment should be optimized.
◆ OptimizeWithMapping()
|
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_kit A SegmentOptimizationOptionsKit that specifies how the Segment should be optimized.
- Returns
- OptimizeMappingResults with information about merged shells.
◆ ReferenceGeometry() [1/2]
|
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_key A 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]
|
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_key A key to either a piece of geometry or a segment. in_conditional A 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()
|
inline |
Sets the attribute locks designated by in_kit on this segment.
◆ SetBounding()
|
inline |
Sets the bounding designated by in_kit on this segment.
◆ SetCamera()
|
inline |
Sets the camera attribute designated by in_kit on this segment.
◆ SetColorInterpolation()
|
inline |
Sets the color interpolation attributes designated by in_kit on this segment.
◆ SetCondition()
|
inline |
Sets in_condition as the only condition on this segment, replacing any existing conditions.
◆ SetConditions()
|
inline |
Sets in_conditions as the only conditions on this segment, replacing any existing conditions.
◆ SetContourLine()
|
inline |
Sets the contour line attributes designated by in_kit on this segment.
◆ SetCulling()
|
inline |
Sets the culling attributes designated by in_kit on this segment.
◆ SetCurveAttribute()
|
inline |
Sets the curve attributes designated by in_kit on this segment.
◆ SetCuttingSectionAttribute()
|
inline |
Sets the cutting section attributes designated by in_kit on this segment.
◆ SetCylinderAttribute()
|
inline |
Sets the cylinder attributes designated by in_kit on this segment.
◆ SetDrawingAttribute()
|
inline |
Sets the drawing attributes designated by in_kit on this segment.
◆ SetEdgeAttribute()
|
inline |
Sets the edge attributes designated by in_kit on this segment.
◆ SetHiddenLineAttribute()
|
inline |
Sets the hidden line attributes designated by in_kit on this segment.
◆ SetLightingAttribute()
|
inline |
Sets the lighting attributes designated by in_kit on this segment.
◆ SetLineAttribute()
|
inline |
Sets the line attributes designated by in_kit on this segment.
◆ SetMarkerAttribute()
|
inline |
Sets the marker attributes designated by in_kit on this segment.
◆ SetMaterialMapping()
|
inline |
Sets the material mappings designated by in_kit on this segment.
◆ SetMaterialPalette()
|
inline |
Applies the material palette associated with in_name to this segment, replacing any existing material palette.
◆ SetModellingMatrix()
|
inline |
Sets the modelling matrix attributes designated by in_kit on this segment.
◆ SetName()
|
inline |
Sets the new name of this segment.
- Returns
- A reference to this key
◆ SetNURBSSurfaceAttribute()
|
inline |
Sets the NURBS surface attributes designated by in_kit on this segment.
◆ SetPBRMaterial()
|
inline |
Sets a PBR material designated by in_kit on this segment.
◆ SetPerformance()
|
inline |
Sets the performance attributes designated by in_kit on this segment.
◆ SetPriority()
|
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_priority The drawing priority, higher priority items are drawn on top of lower priority items.
- Returns
- A reference to this object.
◆ SetSelectability()
|
inline |
Sets the selectability attributes designated by in_kit on this segment.
◆ SetSphereAttribute()
|
inline |
Sets the sphere attributes designated by in_kit on this segment.
◆ SetSubwindow()
|
inline |
Sets the subwindow attributes designated by in_kit on this segment.
◆ SetTextAttribute()
|
inline |
Sets the text attributes designated by in_kit on this segment.
◆ SetTextureMatrix()
|
inline |
Sets the texture matrix attributes designated by in_kit on this segment.
◆ SetTransformMask()
|
inline |
Sets the transform mask designated by in_kit on this segment.
◆ SetTransparency()
|
inline |
Sets the transparency attributes designated by in_kit on this segment.
◆ SetUserData() [1/3]
|
inline |
Sets user data on this key.
- Parameters
-
in_indices An array of user data indices to set. in_data An array of bytes of user data to set.
- Returns
- A reference to this key.
◆ SetUserData() [2/3]
|
inline |
Sets user data on this key.
- Parameters
-
in_index The index of the user data to set. in_bytes The number of bytes of user data to set. in_data The bytes of user data to set.
- Returns
- A reference to this key.
◆ SetUserData() [3/3]
|
inline |
Sets user data on this key.
- Parameters
-
in_index The index of the user data to set. in_data The bytes of user data to set.
- Returns
- A reference to this key.
◆ SetVisibility()
|
inline |
Sets the visibility attribute designated by in_kit on this segment.
◆ SetVisualEffects()
|
inline |
Sets the visual effects attributes designated by in_kit on this segment.
◆ ShowAttributeLock()
|
inline |
Shows the attribute locks settings on this segment.
- Returns
- False if no attribute locks settings exist on this segment.
◆ ShowBounding()
|
inline |
Shows the bounding or bounding settings on this segment.
- Returns
- False if no bounding or bounding settings on this segment.
◆ ShowCamera()
|
inline |
Shows the camera attribute settings on this segment. Returns false if no camera is set on this segment.
◆ ShowColorInterpolation()
|
inline |
Shows the color interpolation attribute settings on this segment. Returns false if no color interpolation attribute settings exist on this segment.
◆ ShowContourLine()
|
inline |
Shows the contour line attribute settings on this segment. Returns false if no contour line attribute settings exist on this segment.
◆ ShowCulling()
|
inline |
Shows the culling attribute settings on this segment.
- Returns
- False if no culling attribute settings exist on this segment.
◆ ShowCurveAttribute()
|
inline |
Shows the curve attribute settings on this segment. Returns false if no curve attribute settings exist on this segment.
◆ ShowCuttingSectionAttribute()
|
inline |
Shows the cutting section attribute settings on this segment. Returns false if no cutting section attribute settings exist on this segment.
◆ ShowCylinderAttribute()
|
inline |
Shows the cylinder attribute settings on this segment. Returns false if no cylinder attribute settings exist on this segment.
◆ ShowDrawingAttribute()
|
inline |
Shows the drawing attribute settings on this segment. Returns false if no drawing settings exist on this segment.
◆ ShowEdgeAttribute()
|
inline |
Shows the edge attribute settings on this segment. Returns false if no edge attribute settings exist on this segment.
◆ ShowHiddenLineAttribute()
|
inline |
Shows the hidden line attribute settings on this segment. Returns false if no hidden line settings exist on this segment.
◆ ShowIncluders() [1/2]
|
inline |
Shows the all the segments which contain includes of this key.
- Parameters
-
out_segments The list of segments which contains includes of this key.
- Returns
- The number of segments which contain includes of this key.
◆ ShowIncluders() [2/2]
|
inline |
Shows the all the includes of this key.
- Parameters
-
out_includes The list of all includes of this key.
- Returns
- The number of includes of this key.
◆ ShowLightingAttribute()
|
inline |
Shows the lighting attribute settings on this segment. Returns false if no lighting attribute settings exist on this segment.
◆ ShowLineAttribute()
|
inline |
Shows the line attribute settings on this segment. Returns false if no line attribute settings exist on this segment.
◆ ShowMarkerAttribute()
|
inline |
Shows the marker attribute settings on this segment. Returns false if no marker attribute settings exist on this segment.
◆ ShowMaterialMapping()
|
inline |
Shows the material mapping settings on this segment. Returns false if no material mapping settings exist on this segment.
◆ ShowMaterialPalette()
|
inline |
Shows the existing material palette, if any, that is active on this segment.
◆ ShowModellingMatrix()
|
inline |
Shows the modelling matrix setting on this segment. Returns false if no modelling matrix setting exists on this segment.
◆ ShowNURBSSurfaceAttribute()
|
inline |
Shows the NURBS surface attribute settings on this segment. Returns false if no NURBS surface attribute settings exist on this segment.
◆ ShowPBRMaterial()
|
inline |
Shows the PBR material settings on this segment. Returns false if no PBR material settings exist on this segment.
◆ ShowPerformance()
|
inline |
Shows the performance attribute settings on this segment. Returns false if no performance settings exist on this segment.
◆ ShowPriority()
|
inline |
Shows the drawing priority.
- Parameters
-
out_priority The 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]
|
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_segments The list of segments which contains references to this key.
- Returns
- The number of segments which contain references to this key.
◆ ShowReferrers() [2/2]
|
inline |
Shows the all the references to this key.
- Parameters
-
out_references The list of all references to this key.
- Returns
- The number of references to this key.
◆ ShowSelectability()
|
inline |
Shows the selectability attribute settings on this segment.
- Returns
- False if no selectability settings exist on this segment.
◆ ShowSphereAttribute()
|
inline |
Shows the sphere attribute settings on this segment.
- Returns
- False if no sphere attribute settings exist on this segment.
◆ ShowStylers() [1/2]
|
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_segments The list of segments which are styled by this key.
- Returns
- The number of segments which are styled by this key.
◆ ShowStylers() [2/2]
|
inline |
Shows the all the styles which refer to this key.
- Parameters
-
out_styles The list of all styles which refer to this key.
- Returns
- The number of styles which refer to this key.
◆ ShowSubwindow()
|
inline |
Shows the subwindow attribute settings on this segment.
- Returns
- False if no subwindow attribute settings exist on this segment.
◆ ShowTextAttribute()
|
inline |
Shows the text attribute settings on this segment. Returns false if no text attribute settings exist on this segment.
◆ ShowTextureMatrix()
|
inline |
Shows the texture matrix setting on this segment.
- Returns
- False if no texture matrix setting exists on this segment.
◆ ShowTransformMask()
|
inline |
Shows the transform mask settings on this segment.
- Returns
- False if no bounding settings exist on this segment.
◆ ShowTransparency()
|
inline |
Shows the transparency attribute settings on this segment.
- Returns
- False if no transparency attribute settings exist on this segment.
◆ ShowUserData() [1/2]
|
inline |
Shows all user data for this key.
- Parameters
-
out_indices An array of all user data indices set on this key. out_data An array of all user data set on this key.
- Returns
- true if there is user data on this key, false otherwise.
◆ ShowUserData() [2/2]
|
inline |
Shows the user data at a given index for this key.
- Parameters
-
in_index The index of the user data to show. out_data The user data at the given index.
- Returns
- true if there is user data at the given index, false otherwise.
◆ ShowUserDataCount()
|
inline |
Get the number of user data indices set on this key.
◆ ShowUserDataIndices()
|
inline |
Shows the indices of all user data set on this key.
- Parameters
-
out_indices The user data indices set on this key.
- Returns
- The number of user data indices set on this key.
◆ ShowVisibility()
|
inline |
Shows the visibility attribute settings on this segment.
- Returns
- False if no visibility is set on this segment.
◆ ShowVisualEffects()
|
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]
|
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]
|
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]
|
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()
|
inline |
Removes all user data from this key.
- Returns
- A reference to this key.
◆ UnsetAttributeLock()
|
inline |
Removes all attribute locks settings from this segment.
◆ UnsetBounding()
|
inline |
Removes all bounding settings from this segment.
◆ UnsetCamera()
|
inline |
Removes any camera set on this segment.
◆ UnsetColorInterpolation()
|
inline |
Removes any color interpolation attributes set on this segment.
◆ UnsetConditions()
|
inline |
Unsets all conditions on this segment.
◆ UnsetContourLine()
|
inline |
Removes any contour line attributes set on this segment.
◆ UnsetCulling()
|
inline |
Removes all culling attribute settings from this segment.
◆ UnsetCurveAttribute()
|
inline |
Removes all curve attribute settings from this segment.
◆ UnsetCuttingSectionAttribute()
|
inline |
Removes all cutting section attribute settings from this segment.
◆ UnsetCylinderAttribute()
|
inline |
Removes all cylinder attribute settings from this segment.
◆ UnsetDrawingAttribute()
|
inline |
Removes all drawing settings from this segment.
◆ UnsetEdgeAttribute()
|
inline |
Removes all edge attribute settings from this segment.
◆ UnsetHiddenLineAttribute()
|
inline |
Removes all hidden line settings from this segment.
◆ UnsetLightingAttribute()
|
inline |
Removes all lighting attribute settings from this segment.
◆ UnsetLineAttribute()
|
inline |
Removes all line attribute settings from this segment.
◆ UnsetMarkerAttribute()
|
inline |
Removes all marker attribute settings from this segment.
◆ UnsetMaterialMapping()
|
inline |
Removes all material mapping settings from this segment.
◆ UnsetMaterialPalette()
|
inline |
Removes the existing material palette, if any, that is active on this segment.
◆ UnsetModellingMatrix()
|
inline |
Removes any modelling matrix settings from this segment.
◆ UnsetNURBSSurfaceAttribute()
|
inline |
Removes all NURBS surface attribute settings from this segment.
◆ UnsetPBRMaterial()
|
inline |
Removes all PBR material settings from this segment.
◆ UnsetPerformance()
|
inline |
Removes all performance settings from this segment.
◆ UnsetPriority()
|
inline |
Removes the drawing priority setting.
- Returns
- A reference to this object.
◆ UnsetSelectability()
|
inline |
Removes all selectability settings from this segment.
◆ UnsetSphereAttribute()
|
inline |
Removes all sphere attribute settings from this segment.
◆ UnsetSubwindow()
|
inline |
Removes all subwindow attribute settings from this segment.
◆ UnsetTextAttribute()
|
inline |
Removes all text attribute settings from this segment.
◆ UnsetTextureMatrix()
|
inline |
Removes any texture matrix settings from this segment.
◆ UnsetTransformMask()
|
inline |
Removes all transform mask settings from this segment.
◆ UnsetTransparency()
|
inline |
Removes all transparency attribute settings from this segment.
◆ UnsetUserData() [1/2]
|
inline |
Removes the user data at the given index from this key.
- Parameters
-
in_index The index of the user data to remove.
- Returns
- A reference to this key.
◆ UnsetUserData() [2/2]
|
inline |
Removes the user data at the given indices from this key.
- Parameters
-
in_indices The indices of the user data to remove.
- Returns
- A reference to this key.
◆ UnsetVisibility()
|
inline |
Removes all visibility settings from this segment.
◆ 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