REFERENCE MANUAL
#include <hps.h>
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
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.
SegmentKey::SegmentKey | ( | ) |
An uninitialized key refers to no database object and Type() will return Type::None.
SegmentKey::SegmentKey | ( | SegmentKey const & | in_that | ) |
Shares a reference to a database object referred to by in_that.
SegmentKey::SegmentKey | ( | SegmentKey && | in_that | ) |
The move constructor creates a SegmentKey by transferring the underlying impl of the rvalue reference to this SegmentKey thereby avoiding a copy and allocation.
in_that | An rvalue reference to a SegmentKey to take the impl from. |
|
explicit |
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::~SegmentKey | ( | ) |
Releases a reference to a database object but does not destroy the database object.
SegmentKey SegmentKey::Down | ( | char const * | in_segment_name, |
bool | in_create_if_not_present = false |
||
) | const |
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.
size_t SegmentKey::Find | ( | Search::Type | in_request, |
Search::Space | in_search_space, | ||
SearchResults & | out_results | ||
) | const |
Searches in_search_space for in_request and returns a handle to the results.
size_t SegmentKey::Find | ( | SearchTypeArray const & | in_requests, |
Search::Space | in_search_space, | ||
SearchResults & | out_results | ||
) | const |
Searches in_search_space for in_request and returns a handle to the results.
size_t SegmentKey::Find | ( | size_t | in_types_count, |
Search::Type const | in_requests[], | ||
Search::Space | in_search_space, | ||
SearchResults & | out_results | ||
) | const |
Searches in_search_space for in_request and returns a handle to the results.
size_t SegmentKey::Find | ( | SearchOptionsKit const & | in_options, |
SearchResults & | out_results | ||
) | const |
Searches starting at this segment using in_options and writes found objects into out_results, returns count.
size_t SegmentKey::Find | ( | SearchOptionsKit const & | in_options | ) | const |
Searches starting at this segment using in_options, returns count.
void SegmentKey::Flush | ( | Search::Type | in_type_to_remove = Search::Type::Everything , |
Search::Space | in_search_space = Search::Space::SegmentOnly |
||
) |
Searches in_search_space for in_type_to_remove and deletes all instances from the segment(s).
void SegmentKey::Flush | ( | SearchTypeArray const & | in_types_to_remove, |
Search::Space | in_search_space = Search::Space::SegmentOnly |
||
) |
Searches in_search_space for in_types_to_remove and deletes all instances from the segment(s).
void SegmentKey::Flush | ( | size_t | in_types_count, |
Search::Type const | in_types_to_remove[], | ||
Search::Space | in_search_space = Search::Space::SegmentOnly |
||
) |
Searches in_search_space for in_types_to_remove and deletes all instances from the segment(s).
AttributeLockControl SegmentKey::GetAttributeLockControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the attribute locks on this segment.
AttributeLockControl const SegmentKey::GetAttributeLockControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the attribute locks on this segment.
BoundingControl SegmentKey::GetBoundingControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the bounding control on this segment.
BoundingControl const SegmentKey::GetBoundingControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the bounding control on this segment.
CameraControl SegmentKey::GetCameraControl | ( | ) |
CameraControl const SegmentKey::GetCameraControl | ( | ) | const |
ColorInterpolationControl SegmentKey::GetColorInterpolationControl | ( | ) |
ColorInterpolationControl const SegmentKey::GetColorInterpolationControl | ( | ) | const |
ConditionControl SegmentKey::GetConditionControl | ( | ) |
ConditionControl const SegmentKey::GetConditionControl | ( | ) | const |
ContourLineControl SegmentKey::GetContourLineControl | ( | ) |
ContourLineControl const SegmentKey::GetContourLineControl | ( | ) | const |
CullingControl SegmentKey::GetCullingControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the culling attribute on this segment.
CullingControl const SegmentKey::GetCullingControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the culling attribute on this segment.
CurveAttributeControl SegmentKey::GetCurveAttributeControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the curve attribute on this segment.
CurveAttributeControl const SegmentKey::GetCurveAttributeControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the curve attribute on this segment.
CuttingSectionAttributeControl SegmentKey::GetCuttingSectionAttributeControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the cutting section attributes on this segment.
CuttingSectionAttributeControl const SegmentKey::GetCuttingSectionAttributeControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the cutting section attributes on this segment.
CylinderAttributeControl SegmentKey::GetCylinderAttributeControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the cylinder attribute on this segment.
CylinderAttributeControl const SegmentKey::GetCylinderAttributeControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the cylinder attribute on this segment.
DrawingAttributeControl SegmentKey::GetDrawingAttributeControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the drawing attribute on this segment.
DrawingAttributeControl const SegmentKey::GetDrawingAttributeControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the drawing attribute on this segment.
EdgeAttributeControl SegmentKey::GetEdgeAttributeControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the edge attribute on this segment.
EdgeAttributeControl const SegmentKey::GetEdgeAttributeControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the edge attribute on this segment.
HiddenLineAttributeControl SegmentKey::GetHiddenLineAttributeControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the hidden line attribute on this segment.
HiddenLineAttributeControl const SegmentKey::GetHiddenLineAttributeControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the hidden line attribute on this segment.
LightingAttributeControl SegmentKey::GetLightingAttributeControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the lighting attribute on this segment.
LightingAttributeControl const SegmentKey::GetLightingAttributeControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the lighting attribute on this segment.
LineAttributeControl SegmentKey::GetLineAttributeControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the line attribute on this segment.
LineAttributeControl const SegmentKey::GetLineAttributeControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the line attribute on this segment.
MarkerAttributeControl SegmentKey::GetMarkerAttributeControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the marker attribute on this segment.
MarkerAttributeControl const SegmentKey::GetMarkerAttributeControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the marker attribute on this segment.
MaterialMappingControl SegmentKey::GetMaterialMappingControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the material mapping on this segment.
MaterialMappingControl const SegmentKey::GetMaterialMappingControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the material mapping on this segment.
ModellingMatrixControl SegmentKey::GetModellingMatrixControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the modelling matrix on this segment.
ModellingMatrixControl const SegmentKey::GetModellingMatrixControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the modelling matrix on this segment.
NURBSSurfaceAttributeControl SegmentKey::GetNURBSSurfaceAttributeControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the NURBS surface attribute on this segment.
NURBSSurfaceAttributeControl const SegmentKey::GetNURBSSurfaceAttributeControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the NURBS surface attribute on this segment.
PerformanceControl SegmentKey::GetPerformanceControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the performance attribute on this segment.
PerformanceControl const SegmentKey::GetPerformanceControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the performance attribute on this segment.
PortfolioControl SegmentKey::GetPortfolioControl | ( | ) |
PortfolioControl const SegmentKey::GetPortfolioControl | ( | ) | const |
SelectabilityControl SegmentKey::GetSelectabilityControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the selectability attribute on this segment.
SelectabilityControl const SegmentKey::GetSelectabilityControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the selectability attribute on this segment.
SphereAttributeControl SegmentKey::GetSphereAttributeControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the sphere attribute on this segment.
SphereAttributeControl const SegmentKey::GetSphereAttributeControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the sphere attribute on this segment.
StyleControl SegmentKey::GetStyleControl | ( | ) |
StyleControl const SegmentKey::GetStyleControl | ( | ) | const |
SubwindowControl SegmentKey::GetSubwindowControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the subwindow attribute on this segment.
SubwindowControl const SegmentKey::GetSubwindowControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the subwindow attribute on this segment.
TextAttributeControl SegmentKey::GetTextAttributeControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the text attribute on this segment.
TextAttributeControl const SegmentKey::GetTextAttributeControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the text attribute on this segment.
TextureMatrixControl SegmentKey::GetTextureMatrixControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the texture matrix on this segment.
TextureMatrixControl const SegmentKey::GetTextureMatrixControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the texture matrix on this segment.
TransformMaskControl SegmentKey::GetTransformMaskControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the transform mask on this segment.
TransformMaskControl const SegmentKey::GetTransformMaskControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the transform mask on this segment.
TransparencyControl SegmentKey::GetTransparencyControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the transparency attribute on this segment.
TransparencyControl const SegmentKey::GetTransparencyControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the transparency attribute on this segment.
VisibilityControl SegmentKey::GetVisibilityControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the visibility attribute on this segment.
VisibilityControl const SegmentKey::GetVisibilityControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the visibility attribute on this segment.
VisualEffectsControl SegmentKey::GetVisualEffectsControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the visual effects attribute on this segment.
VisualEffectsControl const SegmentKey::GetVisualEffectsControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the visual effects attribute on this segment.
IncludeKey SegmentKey::IncludeSegment | ( | SegmentKey const & | 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.
IncludeKey SegmentKey::IncludeSegment | ( | SegmentKey const & | in_seg, |
Condition const & | in_condition | ||
) |
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.
Creates a new circle geometry in this segment and returns a key to it.
CircleKey SegmentKey::InsertCircle | ( | Point const & | in_start, |
Point const & | in_middle, | ||
Point const & | in_end | ||
) |
Creates a new circle geometry in this segment and returns a key to it.
CircleKey SegmentKey::InsertCircle | ( | Point const & | in_center, |
float | in_radius, | ||
Vector const & | in_normal | ||
) |
Creates a new circle geometry in this segment and returns a key to it.
CircularArcKey SegmentKey::InsertCircularArc | ( | CircularArcKit const & | in_kit | ) |
Creates a new circular arc geometry in this segment and returns a key to it.
CircularArcKey SegmentKey::InsertCircularArc | ( | Point const & | in_start, |
Point const & | in_middle, | ||
Point const & | in_end | ||
) |
Creates a new circular arc geometry in this segment and returns a key to it.
CircularWedgeKey SegmentKey::InsertCircularWedge | ( | CircularWedgeKit const & | in_kit | ) |
Creates a new circular wedge geometry in this segment and returns a key to it.
CircularWedgeKey SegmentKey::InsertCircularWedge | ( | Point const & | in_start, |
Point const & | in_middle, | ||
Point const & | in_end | ||
) |
Creates a new circular wedge geometry in this segment and returns a key to it.
CuttingSectionKey SegmentKey::InsertCuttingSection | ( | Plane const & | in_plane | ) |
Creates a new cutting section in this segment and returns a key to it.
CuttingSectionKey SegmentKey::InsertCuttingSection | ( | CuttingSectionKit const & | in_kit | ) |
Creates a new cutting section in this segment and returns a key to it.
CuttingSectionKey SegmentKey::InsertCuttingSection | ( | PlaneArray const & | in_planes | ) |
Creates a new cutting section in this segment and returns a key to it.
CuttingSectionKey SegmentKey::InsertCuttingSection | ( | size_t | in_planes_count, |
Plane const | in_planes[] | ||
) |
Creates a new cutting section in this segment and returns a key to it.
CylinderKey SegmentKey::InsertCylinder | ( | CylinderKit const & | in_kit | ) |
Creates a new cylinder geometry in this segment and returns a key to it.
CylinderKey SegmentKey::InsertCylinder | ( | size_t | in_pcount, |
Point const | in_points[], | ||
size_t | in_rcount, | ||
float const | in_radii[], | ||
Cylinder::Capping | in_caps = Cylinder::Capping::Both |
||
) |
Creates a new cylinder geometry in this segment and returns a key to it.
CylinderKey SegmentKey::InsertCylinder | ( | PointArray const & | in_points, |
FloatArray const & | in_radii, | ||
Cylinder::Capping | in_caps = Cylinder::Capping::Both |
||
) |
Creates a new cylinder geometry in this segment and returns a key to it.
CylinderKey SegmentKey::InsertCylinder | ( | Point const & | in_point1, |
Point const & | in_point2, | ||
float | in_radius, | ||
Cylinder::Capping | in_caps = Cylinder::Capping::Both |
||
) |
Creates a new cylinder geometry in this segment and returns a key to it.
DistantLightKey SegmentKey::InsertDistantLight | ( | Vector const & | in_direction | ) |
Creates a new distant light geometry in this segment and returns a key to it.
DistantLightKey SegmentKey::InsertDistantLight | ( | DistantLightKit const & | in_kit | ) |
Creates a new distant light geometry in this segment and returns a key to it.
EllipseKey SegmentKey::InsertEllipse | ( | EllipseKit const & | in_kit | ) |
Creates a new ellipse geometry in this segment and returns a key to it.
EllipseKey SegmentKey::InsertEllipse | ( | Point const & | in_center, |
Point const & | in_major, | ||
Point const & | in_minor | ||
) |
Creates a new ellipse geometry in this segment and returns a key to it.
EllipticalArcKey SegmentKey::InsertEllipticalArc | ( | EllipticalArcKit const & | in_kit | ) |
Creates a new elliptical arc geometry in this segment and returns a key to it.
EllipticalArcKey SegmentKey::InsertEllipticalArc | ( | Point const & | in_center, |
Point const & | in_major, | ||
Point const & | in_minor, | ||
float | start, | ||
float | end | ||
) |
Creates a new elliptical arc geometry in this segment and returns a key to it.
Creates a new grid in this segment and returns a key to it.
GridKey SegmentKey::InsertGrid | ( | Point const & | in_origin, |
Point const & | in_first_point = Point(1, 0, 0) , |
||
Point const & | in_second_point = Point(0, 1, 0) , |
||
int | in_first_count = 0 , |
||
int | in_second_count = 0 , |
||
Grid::Type | in_type = Grid::Type::Quadrilateral |
||
) |
Creates a new grid in this segment and returns a key to it.
InfiniteLineKey SegmentKey::InsertInfiniteLine | ( | InfiniteLineKit const & | in_kit | ) |
Creates a new infinite line geometry in this segment and returns a key to it.
InfiniteLineKey SegmentKey::InsertInfiniteLine | ( | Point const & | in_first, |
Point const & | in_second, | ||
InfiniteLine::Type | in_type | ||
) |
Creates a new infinite line geometry in this segment and returns a key to it.
Creates a new line geometry in this segment and returns a key to it.
Creates a new line geometry in this segment and returns a key to it.
LineKey SegmentKey::InsertLine | ( | PointArray const & | in_pts | ) |
Creates a new line geometry in this segment and returns a key to it.
Creates a new line geometry in this segment and returns a key to it.
LineKey SegmentKey::InsertLineFromGeometry | ( | CircleKey const & | in_circle, |
float | in_deviation = -1.0f |
||
) |
Creates a new line geometry in this segment which approximates the given circle and returns a key to it.
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. |
LineKey SegmentKey::InsertLineFromGeometry | ( | CircularArcKey const & | in_circular_arc, |
float | in_deviation = -1.0f |
||
) |
Creates a new line geometry in this segment which approximates the given circular arc and returns a key to it.
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. |
LineKey SegmentKey::InsertLineFromGeometry | ( | CircularWedgeKey const & | in_circular_wedge, |
float | in_deviation = -1.0f |
||
) |
Creates a new line geometry in this segment which approximates the given circular wedge and returns a key to it.
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. |
LineKey SegmentKey::InsertLineFromGeometry | ( | EllipseKey const & | in_ellipse, |
float | in_deviation = -1.0f |
||
) |
Creates a new line geometry in this segment which approximates the given ellipse and returns a key to it.
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. |
LineKey SegmentKey::InsertLineFromGeometry | ( | EllipticalArcKey const & | in_elliptical_arc, |
float | in_deviation = -1.0f |
||
) |
Creates a new line geometry in this segment which approximates the given elliptical arc and returns a key to it.
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. |
LineKey SegmentKey::InsertLineFromGeometry | ( | NURBSCurveKey const & | in_nurbs_curve, |
float | in_deviation = -1.0f |
||
) |
Creates a new line geometry in this segment which approximates the given NURBS curve and returns a key to it.
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. |
Creates a new marker geometry in this segment and returns a key to it.
Creates a new marker geometry in this segment and returns a key to it.
Creates a new mesh geometry in this segment and returns a key to it.
MeshKey SegmentKey::InsertMesh | ( | size_t | in_rows, |
size_t | in_columns, | ||
PointArray const & | in_points | ||
) |
Creates a new mesh geometry in this segment and returns a key to it.
MeshKey SegmentKey::InsertMesh | ( | size_t | in_rows, |
size_t | in_columns, | ||
size_t | in_point_count, | ||
Point const | in_points[] | ||
) |
Creates a new mesh geometry in this segment and returns a key to it.
NURBSCurveKey SegmentKey::InsertNURBSCurve | ( | NURBSCurveKit const & | in_kit | ) |
Creates a new NURBS curve geometry in this segment and returns a key to it.
NURBSCurveKey SegmentKey::InsertNURBSCurve | ( | size_t | in_degree, |
PointArray const & | in_points, | ||
FloatArray const & | in_weights, | ||
FloatArray const & | 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.
NURBSCurveKey SegmentKey::InsertNURBSCurve | ( | size_t | in_degree, |
size_t | in_pcount, | ||
Point const | in_points[], | ||
float const | in_weights[], | ||
size_t | in_knot_count, | ||
float const | 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.
NURBSSurfaceKey SegmentKey::InsertNURBSSurface | ( | NURBSSurfaceKit const & | in_kit | ) |
Creates a new NURBS surface geometry in this segment and returns a key to it.
NURBSSurfaceKey SegmentKey::InsertNURBSSurface | ( | size_t | in_udegree, |
size_t | in_vdegree, | ||
size_t | in_ucount, | ||
size_t | in_vcount, | ||
PointArray const & | in_points, | ||
FloatArray const & | in_weights, | ||
FloatArray const & | in_uknots, | ||
FloatArray const & | in_vknots | ||
) |
Creates a new NURBS surface geometry in this segment and returns a key to it.
NURBSSurfaceKey SegmentKey::InsertNURBSSurface | ( | size_t | in_udegree, |
size_t | in_vdegree, | ||
size_t | in_ucount, | ||
size_t | in_vcount, | ||
size_t | in_point_count, | ||
Point const | in_points[], | ||
float const | in_weights[], | ||
size_t | in_uknot_count, | ||
float const | in_uknots[], | ||
size_t | in_vknot_count, | ||
float const | in_vknots[] | ||
) |
Creates a new NURBS surface geometry in this segment and returns a key to it.
NURBSSurfaceKey SegmentKey::InsertNURBSSurface | ( | size_t | in_udegree, |
size_t | in_vdegree, | ||
size_t | in_ucount, | ||
size_t | in_vcount, | ||
PointArray const & | in_points, | ||
FloatArray const & | in_weights, | ||
FloatArray const & | in_uknots, | ||
FloatArray const & | in_vknots, | ||
TrimKitArray const & | in_trims | ||
) |
Creates a new NURBS surface geometry in this segment and returns a key to it.
NURBSSurfaceKey SegmentKey::InsertNURBSSurface | ( | size_t | in_udegree, |
size_t | in_vdegree, | ||
size_t | in_ucount, | ||
size_t | in_vcount, | ||
size_t | in_point_count, | ||
Point const | in_points[], | ||
float const | in_weights[], | ||
size_t | in_uknot_count, | ||
float const | in_uknots[], | ||
size_t | in_vknot_count, | ||
float const | in_vknots[], | ||
size_t | in_trim_count, | ||
TrimKit const | in_trims[] | ||
) |
Creates a new NURBS surface geometry in this segment and returns a key to it.
PolygonKey SegmentKey::InsertPolygon | ( | PolygonKit const & | in_kit | ) |
Creates a new polygon geometry in this segment and returns a key to it.
PolygonKey SegmentKey::InsertPolygon | ( | PointArray const & | in_pts | ) |
Creates a new polygon geometry in this segment and returns a key to it.
PolygonKey SegmentKey::InsertPolygon | ( | size_t | in_count, |
Point const | in_points[] | ||
) |
Creates a new polygon geometry in this segment and returns a key to it.
Creates a new shell geometry in this segment and returns a key to it.
ShellKey SegmentKey::InsertShell | ( | PointArray const & | in_points, |
IntArray const & | in_facelist | ||
) |
Creates a new shell geometry in this segment and returns a key to it.
ShellKey SegmentKey::InsertShell | ( | size_t | in_point_count, |
Point const | in_points[], | ||
size_t | in_facelist_count, | ||
int const | in_facelist[] | ||
) |
Creates a new shell geometry in this segment and returns a key to it.
Creates a new shell geometry in this segment which approximates the given sphere and returns a key to it.
in_sphere | The SphereKey that will be used to compute the shell approximation. |
ShellKey SegmentKey::InsertShellFromGeometry | ( | CylinderKey const & | in_cylinder | ) |
Creates a new shell geometry in this segment which approximates the given cylinder and returns a key to it.
in_cylinder | The CylinderKey that will be used to compute the shell approximation. |
ShellKey SegmentKey::InsertShellFromGeometry | ( | NURBSSurfaceKey const & | in_nurbs_surface | ) |
Creates a new shell geometry in this segment which approximates the given NURBS surface and returns a key to it.
in_nurbs_surface | The NURBSSurfaceKey that will be used to compute the shell approximation. |
Creates a new shell geometry in this segment which approximates the given mesh and returns a key to it.
in_mesh | The MeshKey that will be used to compute the shell approximation. |
ShellKey SegmentKey::InsertShellFromGeometry | ( | PolygonKey const & | in_polygon | ) |
Creates a new shell geometry in this segment which approximates the given polygon and returns a key to it.
in_polygon | The PolygonKey that will be used to compute the shell approximation. |
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.
in_text | The TextKey that will be used to compute the shell approximation. |
Creates a new sphere geometry in this segment and returns a key to it.
in_kit | The SphereKit that will define the sphere |
SphereKey SegmentKey::InsertSphere | ( | Point const & | in_center, |
float | in_radius, | ||
Vector const & | in_axis = Vector(0, 1, 0) , |
||
Vector const & | in_prime_meridian = Vector(1, 0, 0) |
||
) |
Creates a new sphere geometry in this segment and returns a key to it.
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) |
SpotlightKey SegmentKey::InsertSpotlight | ( | Point const & | in_position, |
Point const & | in_target | ||
) |
Creates a new spot light geometry in this segment and returns a key to it.
SpotlightKey SegmentKey::InsertSpotlight | ( | SpotlightKit const & | in_kit | ) |
Creates a new spot light geometry in this segment and returns a key to it.
Creates a new text geometry in this segment and returns a key to it.
Creates a new text geometry in this segment and returns a key to it.
in_position | The position, in world coordinates, where the text will be inserted. |
in_text | The text UTF-8 encoded string to insert. |
UTF8 SegmentKey::Name | ( | ) | const |
Returns the name given to this segment when it was created.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Key.
Reimplemented in OffScreenWindowKey, ApplicationWindowKey, StandAloneWindowKey, and WindowKey.
SegmentKey& SegmentKey::operator= | ( | SegmentKey const & | other | ) |
Copy assignment operator for SegmentKey
SegmentKey& SegmentKey::operator= | ( | SegmentKey && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this SegmentKey thereby avoiding a copy.
in_that | An rvalue reference to a SegmentKey to take the impl from. |
ReferenceKey SegmentKey::ReferenceGeometry | ( | Key const & | 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).
in_key | A key to either a piece of geometry or a segment. |
ReferenceKey SegmentKey::ReferenceGeometry | ( | Key const & | in_key, |
Condition const & | in_condition | ||
) |
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.
in_key | A key to either a piece of geometry or a segment. |
in_condition | A conditional expression which will determine whether the referenced geometry gets drawn for this segment. |
SegmentKey& SegmentKey::SetAttributeLocks | ( | AttributeLockKit const & | in_kit | ) |
Sets the attribute locks designated by in_kit on this segment.
SegmentKey& SegmentKey::SetBoundings | ( | BoundingKit const & | in_kit | ) |
Sets the bounding designated by in_kit on this segment.
SegmentKey& SegmentKey::SetCamera | ( | CameraKit const & | in_kit | ) |
Sets the camera attribute designated by in_kit on this segment.
SegmentKey& SegmentKey::SetColorInterpolation | ( | ColorInterpolationKit const & | in_kit | ) |
Sets the color interpolation attributes designated by in_kit on this segment.
SegmentKey& SegmentKey::SetCondition | ( | char const * | in_condition | ) |
Sets in_condition as the only condition on this segment, replacing any existing conditions.
SegmentKey& SegmentKey::SetConditions | ( | UTF8Array const & | in_conditions | ) |
Sets in_conditions as the only conditions on this segment, replacing any existing conditions.
SegmentKey& SegmentKey::SetConditions | ( | size_t | in_count, |
UTF8 const | in_conditions[] | ||
) |
Sets in_conditions as the only conditions on this segment, replacing any existing conditions.
SegmentKey& SegmentKey::SetContourLine | ( | ContourLineKit const & | in_kit | ) |
Sets the contour line attributes designated by in_kit on this segment.
SegmentKey& SegmentKey::SetCulling | ( | CullingKit const & | in_kit | ) |
Sets the culling attributes designated by in_kit on this segment.
SegmentKey& SegmentKey::SetCurveAttributes | ( | CurveAttributeKit const & | in_kit | ) |
Sets the curve attributes designated by in_kit on this segment.
SegmentKey& SegmentKey::SetCuttingSectionAttributes | ( | CuttingSectionAttributeKit const & | in_kit | ) |
Sets the cutting section attributes designated by in_kit on this segment.
SegmentKey& SegmentKey::SetCylinderAttributes | ( | CylinderAttributeKit const & | in_kit | ) |
Sets the cylinder attributes designated by in_kit on this segment.
SegmentKey& SegmentKey::SetDrawingAttribute | ( | DrawingAttributeKit const & | in_kit | ) |
Sets the drawing attributes designated by in_kit on this segment.
SegmentKey& SegmentKey::SetEdgeAttributes | ( | EdgeAttributeKit const & | in_kit | ) |
Sets the edge attributes designated by in_kit on this segment.
SegmentKey& SegmentKey::SetHiddenLineAttribute | ( | HiddenLineAttributeKit const & | in_kit | ) |
Sets the hidden line attributes designated by in_kit on this segment.
SegmentKey& SegmentKey::SetLightingAttributes | ( | LightingAttributeKit const & | in_kit | ) |
Sets the lighting attributes designated by in_kit on this segment.
SegmentKey& SegmentKey::SetLineAttributes | ( | LineAttributeKit const & | in_kit | ) |
Sets the line attributes designated by in_kit on this segment.
SegmentKey& SegmentKey::SetMarkerAttributes | ( | MarkerAttributeKit const & | in_kit | ) |
Sets the marker attributes designated by in_kit on this segment.
SegmentKey& SegmentKey::SetMaterialMapping | ( | MaterialMappingKit const & | in_kit | ) |
Sets the material mappings designated by in_kit on this segment.
SegmentKey& SegmentKey::SetMaterialPalette | ( | char const * | in_name | ) |
Applies the material palette associated with in_name to this segment, replacing any existing material palette.
SegmentKey& SegmentKey::SetModellingMatrix | ( | MatrixKit const & | in_kit | ) |
Sets the modelling matrix attributes designated by in_kit on this segment.
SegmentKey& SegmentKey::SetName | ( | char const * | in_name | ) |
Sets the new name of this segment.
SegmentKey& SegmentKey::SetNURBSSurfaceAttributes | ( | NURBSSurfaceAttributeKit const & | in_kit | ) |
Sets the NURBS surface attributes designated by in_kit on this segment.
SegmentKey& SegmentKey::SetPerformance | ( | PerformanceKit const & | in_kit | ) |
Sets the performance attributes designated by in_kit on this segment.
SegmentKey& 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.
in_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
SegmentKey& SegmentKey::SetSelectability | ( | SelectabilityKit const & | in_kit | ) |
Sets the selectability attributes designated by in_kit on this segment.
SegmentKey& SegmentKey::SetSphereAttributes | ( | SphereAttributeKit const & | in_kit | ) |
Sets the sphere attributes designated by in_kit on this segment.
SegmentKey& SegmentKey::SetSubwindow | ( | SubwindowKit const & | in_kit | ) |
Sets the subwindow attributes designated by in_kit on this segment.
SegmentKey& SegmentKey::SetTextAttributes | ( | TextAttributeKit const & | in_kit | ) |
Sets the text attributes designated by in_kit on this segment.
SegmentKey& SegmentKey::SetTextureMatrix | ( | MatrixKit const & | in_kit | ) |
Sets the texture matrix attributes designated by in_kit on this segment.
SegmentKey& SegmentKey::SetTransformMask | ( | TransformMaskKit const & | in_kit | ) |
Sets the transform mask designated by in_kit on this segment.
SegmentKey& SegmentKey::SetTransparency | ( | TransparencyKit const & | in_kit | ) |
Sets the transparency attributes designated by in_kit on this segment.
SegmentKey& SegmentKey::SetUserData | ( | intptr_t | in_index, |
size_t | in_bytes, | ||
byte const | in_data[] | ||
) |
Sets user data on this key.
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. |
SegmentKey& SegmentKey::SetUserData | ( | intptr_t | in_index, |
ByteArray const & | in_data | ||
) |
Sets user data on this key.
in_index | The index of the user data to set. |
in_data | The bytes of user data to set. |
SegmentKey& SegmentKey::SetVisibility | ( | VisibilityKit const & | in_kit | ) |
Sets the visibility attribute designated by in_kit on this segment.
SegmentKey& SegmentKey::SetVisualEffects | ( | VisualEffectsKit const & | in_kit | ) |
Sets the visual effects attributes designated by in_kit on this segment.
bool SegmentKey::ShowAttributeLocks | ( | AttributeLockKit & | out_kit | ) | const |
Shows the attribute locks settings on this segment.
bool SegmentKey::ShowBoundings | ( | BoundingKit & | out_kit | ) | const |
Shows the bounding or bounding settings on this segment.
bool SegmentKey::ShowCamera | ( | CameraKit & | out_kit | ) | const |
Shows the camera attribute settings on this segment. Returns false if no camera is set on this segment.
bool SegmentKey::ShowColorInterpolation | ( | ColorInterpolationKit & | out_kit | ) | const |
Shows the color interpolation attribute settings on this segment. Returns false if no color interpolation attribute settings exist on this segment.
bool SegmentKey::ShowConditions | ( | UTF8Array & | out_conditions | ) | const |
Shows all conditions on this segment.
bool SegmentKey::ShowContourLine | ( | ContourLineKit & | out_kit | ) | const |
Shows the contour line attribute settings on this segment. Returns false if no contour line attribute settings exist on this segment.
bool SegmentKey::ShowCulling | ( | CullingKit & | out_kit | ) | const |
Shows the culling attribute settings on this segment.
bool SegmentKey::ShowCurveAttributes | ( | CurveAttributeKit & | out_kit | ) | const |
Shows the curve attribute settings on this segment. Returns false if no curve attribute settings exist on this segment.
bool SegmentKey::ShowCuttingSectionAttributes | ( | CuttingSectionAttributeKit & | out_kit | ) | const |
Shows the cutting section attribute settings on this segment. Returns false if no cutting section attribute settings exist on this segment.
bool SegmentKey::ShowCylinderAttributes | ( | CylinderAttributeKit & | out_kit | ) | const |
Shows the cylinder attribute settings on this segment. Returns false if no cylinder attribute settings exist on this segment.
bool SegmentKey::ShowDrawingAttribute | ( | DrawingAttributeKit & | out_kit | ) | const |
Shows the drawing attribute settings on this segment. Returns false if no drawing settings exist on this segment.
bool SegmentKey::ShowEdgeAttributes | ( | EdgeAttributeKit & | out_kit | ) | const |
Shows the edge attribute settings on this segment. Returns false if no edge attribute settings exist on this segment.
bool SegmentKey::ShowHiddenLineAttribute | ( | HiddenLineAttributeKit & | out_kit | ) | const |
Shows the hidden line attribute settings on this segment. Returns false if no hidden line settings exist on this segment.
size_t SegmentKey::ShowIncluders | ( | SegmentKeyArray & | out_segments | ) | const |
Shows the all the segments which contain includes of this key.
out_segments | The list of segments which contains includes of this key. |
size_t SegmentKey::ShowIncluders | ( | IncludeKeyArray & | out_includes | ) | const |
Shows the all the includes of this key.
out_includes | The list of all includes of this key. |
bool SegmentKey::ShowLightingAttributes | ( | LightingAttributeKit & | out_kit | ) | const |
Shows the lighting attribute settings on this segment. Returns false if no lighting attribute settings exist on this segment.
bool SegmentKey::ShowLineAttributes | ( | LineAttributeKit & | out_kit | ) | const |
Shows the line attribute settings on this segment. Returns false if no line attribute settings exist on this segment.
bool SegmentKey::ShowMarkerAttributes | ( | MarkerAttributeKit & | out_kit | ) | const |
Shows the marker attribute settings on this segment. Returns false if no marker attribute settings exist on this segment.
bool SegmentKey::ShowMaterialMapping | ( | MaterialMappingKit & | out_kit | ) | const |
Shows the material mapping settings on this segment. Returns false if no material mapping settings exist on this segment.
bool SegmentKey::ShowMaterialPalette | ( | UTF8 & | out_name | ) | const |
Shows the existing material palette, if any, that is active on this segment.
bool SegmentKey::ShowModellingMatrix | ( | MatrixKit & | out_kit | ) | const |
Shows the modelling matrix setting on this segment. Returns false if no modelling matrix setting exists on this segment.
bool SegmentKey::ShowNURBSSurfaceAttributes | ( | NURBSSurfaceAttributeKit & | out_kit | ) | const |
Shows the NURBS surface attribute settings on this segment. Returns false if no NURBS surface attribute settings exist on this segment.
bool SegmentKey::ShowPerformance | ( | PerformanceKit & | out_kit | ) | const |
Shows the performance attribute settings on this segment. Returns false if no performance settings exist on this segment.
bool SegmentKey::ShowPriority | ( | int & | out_priority | ) | const |
Shows the drawing priority.
out_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
size_t SegmentKey::ShowReferrers | ( | SegmentKeyArray & | out_segments | ) | const |
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.
out_segments | The list of segments which contains references to this key. |
size_t SegmentKey::ShowReferrers | ( | ReferenceKeyArray & | out_references | ) | const |
Shows the all the references to this key.
out_references | The list of all references to this key. |
bool SegmentKey::ShowSelectability | ( | SelectabilityKit & | out_kit | ) | const |
Shows the selectability attribute settings on this segment.
bool SegmentKey::ShowSphereAttributes | ( | SphereAttributeKit & | out_kit | ) | const |
Shows the sphere attribute settings on this segment.
size_t SegmentKey::ShowStylers | ( | SegmentKeyArray & | out_segments | ) | const |
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.
out_segments | The list of segments which are styled by this key. |
size_t SegmentKey::ShowStylers | ( | StyleKeyArray & | out_styles | ) | const |
Shows the all the styles which refer to this key.
out_styles | The list of all styles which refer to this key. |
size_t SegmentKey::ShowSubsegments | ( | ) | const |
size_t SegmentKey::ShowSubsegments | ( | SegmentKeyArray & | out_children | ) | const |
bool SegmentKey::ShowSubwindow | ( | SubwindowKit & | out_kit | ) | const |
Shows the subwindow attribute settings on this segment.
bool SegmentKey::ShowTextAttributes | ( | TextAttributeKit & | out_kit | ) | const |
Shows the text attribute settings on this segment. Returns false if no text attribute settings exist on this segment.
bool SegmentKey::ShowTextureMatrix | ( | MatrixKit & | out_kit | ) | const |
Shows the texture matrix setting on this segment.
bool SegmentKey::ShowTransformMask | ( | TransformMaskKit & | out_kit | ) | const |
Shows the transform mask settings on this segment.
bool SegmentKey::ShowTransparency | ( | TransparencyKit & | out_kit | ) | const |
Shows the transparency attribute settings on this segment.
bool SegmentKey::ShowUserData | ( | intptr_t | in_index, |
ByteArray & | out_data | ||
) | const |
Shows the user data at a given index for this key.
in_index | The index of the user data to show. |
out_data | The user data at the given index. |
size_t SegmentKey::ShowUserDataCount | ( | ) | const |
Get the number of user data indices set on this key.
bool SegmentKey::ShowUserDataIndices | ( | IntPtrTArray & | out_indices | ) | const |
Shows the indices of all user data set on this key.
out_indices | The user data indices set on this key. |
bool SegmentKey::ShowVisibility | ( | VisibilityKit & | out_kit | ) | const |
Shows the visibility attribute settings on this segment.
bool SegmentKey::ShowVisualEffects | ( | VisualEffectsKit & | out_kit | ) | const |
Shows the visual effects attribute settings on this segment.
SegmentKey SegmentKey::Subsegment | ( | char const * | in_segment_name = "" , |
bool | in_create_if_not_present = true |
||
) | const |
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.
SegmentKey& SegmentKey::UnsetAllUserData | ( | ) |
Removes all user data from this key.
SegmentKey& SegmentKey::UnsetAttributeLocks | ( | ) |
Removes all attribute locks settings from this segment.
SegmentKey& SegmentKey::UnsetBoundings | ( | ) |
Removes all bounding settings from this segment.
SegmentKey& SegmentKey::UnsetCamera | ( | ) |
Removes any camera set on this segment.
SegmentKey& SegmentKey::UnsetColorInterpolation | ( | ) |
Removes any color interpolation attributes set on this segment.
SegmentKey& SegmentKey::UnsetConditions | ( | ) |
Unsets all conditions on this segment.
SegmentKey& SegmentKey::UnsetContourLine | ( | ) |
Removes any contour line attributes set on this segment.
SegmentKey& SegmentKey::UnsetCulling | ( | ) |
Removes all culling attribute settings from this segment.
SegmentKey& SegmentKey::UnsetCurveAttributes | ( | ) |
Removes all curve attribute settings from this segment.
SegmentKey& SegmentKey::UnsetCuttingSectionAttributes | ( | ) |
Removes all cutting section attribute settings from this segment.
SegmentKey& SegmentKey::UnsetCylinderAttributes | ( | ) |
Removes all cylinder attribute settings from this segment.
SegmentKey& SegmentKey::UnsetDrawingAttribute | ( | ) |
Removes all drawing settings from this segment.
SegmentKey& SegmentKey::UnsetEdgeAttributes | ( | ) |
Removes all edge attribute settings from this segment.
SegmentKey& SegmentKey::UnsetHiddenLineAttribute | ( | ) |
Removes all hidden line settings from this segment.
SegmentKey& SegmentKey::UnsetLightingAttributes | ( | ) |
Removes all lighting attribute settings from this segment.
SegmentKey& SegmentKey::UnsetLineAttributes | ( | ) |
Removes all line attribute settings from this segment.
SegmentKey& SegmentKey::UnsetMarkerAttributes | ( | ) |
Removes all marker attribute settings from this segment.
SegmentKey& SegmentKey::UnsetMaterialMapping | ( | ) |
Removes all material mapping settings from this segment.
SegmentKey& SegmentKey::UnsetMaterialPalette | ( | ) |
Removes the existing material palette, if any, that is active on this segment.
SegmentKey& SegmentKey::UnsetModellingMatrix | ( | ) |
Removes any modelling matrix settings from this segment.
SegmentKey& SegmentKey::UnsetNURBSSurfaceAttributes | ( | ) |
Removes all NURBS surface attribute settings from this segment.
SegmentKey& SegmentKey::UnsetPerformance | ( | ) |
Removes all performance settings from this segment.
SegmentKey& SegmentKey::UnsetPriority | ( | ) |
Removes the drawing priority setting.
SegmentKey& SegmentKey::UnsetSelectability | ( | ) |
Removes all selectability settings from this segment.
SegmentKey& SegmentKey::UnsetSphereAttributes | ( | ) |
Removes all sphere attribute settings from this segment.
SegmentKey& SegmentKey::UnsetSubwindow | ( | ) |
Removes all subwindow attribute settings from this segment.
SegmentKey& SegmentKey::UnsetTextAttributes | ( | ) |
Removes all text attribute settings from this segment.
SegmentKey& SegmentKey::UnsetTextureMatrix | ( | ) |
Removes any texture matrix settings from this segment.
SegmentKey& SegmentKey::UnsetTransformMask | ( | ) |
Removes all transform mask settings from this segment.
SegmentKey& SegmentKey::UnsetTransparency | ( | ) |
Removes all transparency attribute settings from this segment.
SegmentKey& SegmentKey::UnsetUserData | ( | intptr_t | in_index | ) |
Removes the user data at the given index from this key.
in_index | The index of the user data to remove. |
SegmentKey& SegmentKey::UnsetUserData | ( | size_t | in_count, |
intptr_t const | in_indices[] | ||
) |
Removes the user data at the given indices from this key.
in_count | The size of the following array. |
in_indices | The indices of the user data to remove. |
SegmentKey& SegmentKey::UnsetUserData | ( | IntPtrTArray const & | in_indices | ) |
Removes the user data at the given indices from this key.
in_indices | The indices of the user data to remove. |
SegmentKey& SegmentKey::UnsetVisibility | ( | ) |
Removes all visibility settings from this segment.
SegmentKey& SegmentKey::UnsetVisualEffects | ( | ) |
Removes all visual effects attribute settings from this segment.