 |
Hoops Visualize HPS
version 2018-SP2
Hoops Visualize HPS 3D Rendering Engine
|
|
|
Hoops Visualize HPS
version 2018-SP2
Hoops Visualize HPS 3D Rendering Engine
|
|
The WindowKey class is a smart pointer to a database object. More...
#include <hps.h>
Public Member Functions | |
| WindowKey () | |
| An uninitialized key refers to no database object and Type() will return Type::None. More... | |
| WindowKey (WindowKey const &in_window) | |
| Shares a reference to a database object referred to by in_window. More... | |
| WindowKey & | operator= (WindowKey const &other) |
| Copy assignment operator for WindowKey. More... | |
| WindowKey (WindowKey &&in_that) | |
| The move constructor creates a WindowKey by transferring the underlying impl of the rvalue reference to this WindowKey thereby avoiding a copy and allocation. More... | |
| WindowKey & | operator= (WindowKey &&in_that) |
| The move assignment operator transfers the underlying impl of the rvalue reference to this WindowKey thereby avoiding a copy. More... | |
| WindowKey (Key const &in_key) | |
| Shares a reference to a database object referred to by in_that. More... | |
| ~WindowKey () | |
| Releases a reference to a database object but does not destroy the database object. More... | |
| HPS::Type | ObjectType () const |
| bool | ConvertCoordinate (Coordinate::Space in_space, Point const &in_point, Coordinate::Space in_output_space, Point &out_point) const |
| Converts the point in_point from in_space to in_output_space using the transforms associated with this window. More... | |
| size_t | FindFonts (FontSearchResults &out_results) const |
| Searches the system for fonts. More... | |
| size_t | FindHighlights (HighlightSearchOptionsKit const &in_options, HighlightSearchResults &out_results) const |
| Searches for any highlights under this WindowKey. More... | |
| size_t | FindHighlights (KeyPath const &in_key_path, HPS::HighlightSearch::Scope in_scope, HighlightSearchOptionsKit const &in_options, HighlightSearchResults &out_results) const |
| Searches for any highlights under this WindowKey. More... | |
| WindowKey & | SetPostProcessEffects (PostProcessEffectsKit const &in_kit) |
| Sets the post-process effects attributes designated by in_kit on this segment. More... | |
| bool | ShowPostProcessEffects (PostProcessEffectsKit &out_kit) const |
| Shows the post-process effects attribute settings on this segment. More... | |
| PostProcessEffectsControl | GetPostProcessEffectsControl () |
| Returns a control that allows the user to manipulate and query details of the post-process effects attribute on this segment. More... | |
| PostProcessEffectsControl const | GetPostProcessEffectsControl () const |
| Returns a control that allows the user to manipulate and query details of the post-process effects attribute on this segment. More... | |
| WindowKey & | SetDebugging (DebuggingKit const &in_kit) |
| Sets the debugging attributes designated by in_kit on this segment. More... | |
| WindowKey & | SetDriverEventHandler (DriverEventHandler const &in_handler, intptr_t in_type) |
| Sets the specified driver event handler as the handler for the specified driver event type on this window. More... | |
| WindowKey & | UnsetDriverEventHandler (intptr_t in_type) |
| Unsets the driver event handler for the specified driver event type on this window. More... | |
| bool | ShowDebugging (DebuggingKit &out_kit) const |
| Shows the debugging attribute settings on this segment. More... | |
| DebuggingControl | GetDebuggingControl () |
| Returns a control that allows the user to manipulate and query details of the debugging attribute on this segment. More... | |
| DebuggingControl const | GetDebuggingControl () const |
| Returns a control that allows the user to manipulate and query details of the debugging attribute on this segment. More... | |
| WindowInfoControl const | GetWindowInfoControl () const |
| Returns a control that allows the user to query various window properties, including size, aspect ratio, resolution, etc. More... | |
| bool | ShowWindowInfo (WindowInfoKit &out_kit) const |
| WindowKey & | SetSelectionOptions (SelectionOptionsKit const &in_kit) |
| Sets the options that will be used by default for selections performed from this window. More... | |
| bool | ShowSelectionOptions (SelectionOptionsKit &out_kit) const |
| Shows the options that will be used by default for selections performed from this window. More... | |
| WindowKey & | SetUpdateOptions (HPS::UpdateOptionsKit const &in_kit) |
| Sets the options that will be used by default for update options performed from this window. More... | |
| bool | ShowUpdateOptions (HPS::UpdateOptionsKit &out_kit) const |
| Shows the options that will be used by default for update options performed from this window. More... | |
| SelectionOptionsControl | GetSelectionOptionsControl () |
| Returns a control that allows the user to manipulate and query details of the selection options on this window. More... | |
| SelectionOptionsControl const | GetSelectionOptionsControl () const |
| Returns a control that allows the user to manipulate and query details of the selection options on this window. More... | |
| SelectionControl | GetSelectionControl () |
| Returns a control that allows the user to perform selections in this window. More... | |
| SelectionControl const | GetSelectionControl () const |
| Returns a control that allows the user to perform selections in this window. More... | |
| HighlightControl | GetHighlightControl () |
| Returns a control that allows the user to highlight segments or geometry in this window. More... | |
| HighlightControl const | GetHighlightControl () const |
| Returns a control that allows the user to highlight segments or geometry in this window. More... | |
| UpdateOptionsControl | GetUpdateOptionsControl () |
| Returns a control that allows the user to change update options in this window. More... | |
| UpdateOptionsControl const | GetUpdateOptionsControl () const |
| Returns a control that allows the user to change update options in this window. More... | |
| void | Update () |
| Performs a default update in this window, redrawing and refreshing the display. More... | |
| void | Update (UpdateOptionsKit const &in_kit) |
| Performs an update in this window, redrawing and refreshing the display using the options in the UpdateOptionsKit. More... | |
| void | Update (Window::UpdateType in_type, Time in_time_limit=-1) |
| Performs an update in this window within the specified amount of time, redrawing and refreshing the display based on the Window::UpdateType value. More... | |
| UpdateNotifier | UpdateWithNotifier () |
| Performs a default update in this window, redrawing and refreshing the display. More... | |
| UpdateNotifier | UpdateWithNotifier (HPS::UpdateOptionsKit const &in_kit) |
| Performs a default update in this window, redrawing and refreshing the display. More... | |
| UpdateNotifier | UpdateWithNotifier (Window::UpdateType in_type, Time in_time_limit=-1) |
| Performs an update in this window, redrawing and refreshing the display. More... | |
| EventDispatcher & | GetEventDispatcher () |
| Returns a control that allows the user to interact with events in various ways. More... | |
| EventDispatcher const & | GetEventDispatcher () const |
| Returns a control that allows the user to interact with events in various ways. More... | |
| bool | ShowSnapshot (ImageKit &out_kit) const |
| Shows the current display as an image. More... | |
| UTF8 | Name () const |
| Returns the name given to this segment when it was created. More... | |
| SegmentKey & | SetName (char const *in_name) |
| Sets the new name of this segment. More... | |
| 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. More... | |
| 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. More... | |
| void | 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). More... | |
| void | 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). More... | |
| void | 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). More... | |
| size_t | 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. More... | |
| size_t | 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. More... | |
| size_t | 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. More... | |
| size_t | 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. More... | |
| size_t | Find (SearchOptionsKit const &in_options) const |
| Searches starting at this segment using in_options, returns count. More... | |
| IncludeKey | IncludeSegment (SegmentKey const &in_seg) |
| Creates a link between this segment and in_seg, returns a handle to the include itself. More... | |
| IncludeKey | IncludeSegment (SegmentKey const &in_seg, ConditionalExpression const &in_conditional) |
| Creates a link between this segment and in_seg, returns a handle to the include itself. More... | |
| ReferenceKey | ReferenceGeometry (Key const &in_key) |
| References either a geometry key or a segment key in this segment. More... | |
| ReferenceKey | ReferenceGeometry (Key const &in_key, ConditionalExpression const &in_conditional) |
| Conditionally references either a geometry key or a segment key in this segment. More... | |
| size_t | ShowSubsegments () const |
| size_t | ShowSubsegments (SegmentKeyArray &out_children) const |
| size_t | ShowReferrers (SegmentKeyArray &out_segments) const |
| Shows the all the segments which contain references to this key. More... | |
| size_t | ShowReferrers (ReferenceKeyArray &out_references) const |
| Shows the all the references to this key. More... | |
| size_t | ShowStylers (SegmentKeyArray &out_segments) const |
| Shows the all the segments which are styled by this key. More... | |
| size_t | ShowStylers (StyleKeyArray &out_styles) const |
| Shows the all the styles which refer to this key. More... | |
| size_t | ShowIncluders (SegmentKeyArray &out_segments) const |
| Shows the all the segments which contain includes of this key. More... | |
| size_t | ShowIncluders (IncludeKeyArray &out_includes) const |
| Shows the all the includes of this key. More... | |
| StyleControl | GetStyleControl () |
| StyleControl const | GetStyleControl () const |
| PortfolioControl | GetPortfolioControl () |
| PortfolioControl const | GetPortfolioControl () const |
| SegmentKey & | SetCondition (char const *in_condition) |
| Sets in_condition as the only condition on this segment, replacing any existing conditions. More... | |
| SegmentKey & | SetConditions (UTF8Array const &in_conditions) |
| Sets in_conditions as the only conditions on this segment, replacing any existing conditions. More... | |
| SegmentKey & | SetConditions (size_t in_count, UTF8 const in_conditions []) |
| Sets in_conditions as the only conditions on this segment, replacing any existing conditions. More... | |
| SegmentKey & | UnsetConditions () |
| Unsets all conditions on this segment. More... | |
| bool | ShowConditions (UTF8Array &out_conditions) const |
| Shows all conditions on this segment. More... | |
| ConditionControl | GetConditionControl () |
| ConditionControl const | GetConditionControl () const |
| SegmentKey & | SetMaterialPalette (char const *in_name) |
| Applies the material palette associated with in_name to this segment, replacing any existing material palette. More... | |
| SegmentKey & | UnsetMaterialPalette () |
| Removes the existing material palette, if any, that is active on this segment. More... | |
| bool | ShowMaterialPalette (UTF8 &out_name) const |
| Shows the existing material palette, if any, that is active on this segment. More... | |
| SegmentKey & | SetPriority (int in_priority) |
| Assigns a specific drawing priority value to this segment. More... | |
| SegmentKey & | UnsetPriority () |
| Removes the drawing priority setting. More... | |
| bool | ShowPriority (int &out_priority) const |
| Shows the drawing priority. More... | |
| SegmentKey & | SetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data) |
| Sets user data on this key. More... | |
| SegmentKey & | SetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[]) |
| Sets user data on this key. More... | |
| SegmentKey & | SetUserData (intptr_t in_index, ByteArray const &in_data) |
| Sets user data on this key. More... | |
| SegmentKey & | UnsetUserData (intptr_t in_index) |
| Removes the user data at the given index from this key. More... | |
| SegmentKey & | UnsetUserData (size_t in_count, intptr_t const in_indices[]) |
| Removes the user data at the given indices from this key. More... | |
| SegmentKey & | UnsetUserData (HPS::IntPtrTArray const &in_indices) |
| Removes the user data at the given indices from this key. More... | |
| SegmentKey & | UnsetAllUserData () |
| Removes all user data from this key. More... | |
| size_t | ShowUserDataCount () const |
| Get the number of user data indices set on this key. More... | |
| bool | ShowUserData (IntPtrTArray &out_indices, ByteArrayArray &out_data) const |
| Shows all user data for this key. More... | |
| bool | ShowUserData (intptr_t in_index, ByteArray &out_data) const |
| Shows the user data at a given index for this key. More... | |
| bool | ShowUserDataIndices (IntPtrTArray &out_indices) const |
| Shows the indices of all user data set on this key. More... | |
| LineKey | InsertLine (LineKit const &in_kit) |
| Creates a new line geometry in this segment and returns a key to it. More... | |
| LineKey | InsertLine (size_t in_count, Point const in_pts[]) |
| Creates a new line geometry in this segment and returns a key to it. More... | |
| LineKey | InsertLine (PointArray const &in_pts) |
| Creates a new line geometry in this segment and returns a key to it. More... | |
| LineKey | InsertLine (Point const &pt1, Point const &pt2) |
| Creates a new line geometry in this segment and returns a key to it. More... | |
| CylinderKey | InsertCylinder (CylinderKit const &in_kit) |
| Creates a new cylinder geometry in this segment and returns a key to it. More... | |
| CylinderKey | 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. More... | |
| CylinderKey | 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. More... | |
| CylinderKey | 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. More... | |
| SphereKey | InsertSphere (SphereKit const &in_kit) |
| Creates a new sphere geometry in this segment and returns a key to it. More... | |
| SphereKey | 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. More... | |
| CircleKey | InsertCircle (CircleKit const &in_kit) |
| Creates a new circle geometry in this segment and returns a key to it. More... | |
| CircleKey | 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. More... | |
| CircleKey | 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. More... | |
| CircularArcKey | InsertCircularArc (CircularArcKit const &in_kit) |
| Creates a new circular arc geometry in this segment and returns a key to it. More... | |
| CircularArcKey | 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. More... | |
| CircularWedgeKey | InsertCircularWedge (CircularWedgeKit const &in_kit) |
| Creates a new circular wedge geometry in this segment and returns a key to it. More... | |
| CircularWedgeKey | 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. More... | |
| EllipseKey | InsertEllipse (EllipseKit const &in_kit) |
| Creates a new ellipse geometry in this segment and returns a key to it. More... | |
| EllipseKey | 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. More... | |
| EllipticalArcKey | InsertEllipticalArc (EllipticalArcKit const &in_kit) |
| Creates a new elliptical arc geometry in this segment and returns a key to it. More... | |
| EllipticalArcKey | InsertEllipticalArc (Point const &in_center, Point const &in_major, Point const &in_minor, float in_start, float in_end) |
| Creates a new elliptical arc geometry in this segment and returns a key to it. More... | |
| PolygonKey | InsertPolygon (PolygonKit const &in_kit) |
| Creates a new polygon geometry in this segment and returns a key to it. More... | |
| PolygonKey | InsertPolygon (PointArray const &in_points) |
| Creates a new polygon geometry in this segment and returns a key to it. More... | |
| PolygonKey | InsertPolygon (size_t in_count, Point const in_points []) |
| Creates a new polygon geometry in this segment and returns a key to it. More... | |
| ShellKey | InsertShell (ShellKit const &in_kit) |
| Creates a new shell geometry in this segment and returns a key to it. More... | |
| ShellKey | InsertShell (PointArray const &in_points, IntArray const &in_facelist) |
| Creates a new shell geometry in this segment and returns a key to it. More... | |
| ShellKey | 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. More... | |
| ShellKey | InsertShellByTristrips (PointArray const &in_points, IntArray const &in_tristrips) |
| Creates a new shell geometry in this segment and then returns a key to it. More... | |
| ShellKey | InsertShellByTristrips (size_t in_point_count, Point const in_points [], size_t in_tristrips_count, int const in_tristrips []) |
| Creates a new shell geometry in this segment and returns a key to it. More... | |
| MeshKey | InsertMesh (MeshKit const &in_kit) |
| Creates a new mesh geometry in this segment and returns a key to it. More... | |
| MeshKey | 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. More... | |
| MeshKey | 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. More... | |
| MarkerKey | InsertMarker (Point const &in_position) |
| Creates a new marker geometry in this segment and returns a key to it. More... | |
| MarkerKey | InsertMarker (MarkerKit const &in_kit) |
| Creates a new marker geometry in this segment and returns a key to it. More... | |
| DistantLightKey | InsertDistantLight (Vector const &in_direction) |
| Creates a new distant light geometry in this segment and returns a key to it. More... | |
| DistantLightKey | InsertDistantLight (DistantLightKit const &in_kit) |
| Creates a new distant light geometry in this segment and returns a key to it. More... | |
| CuttingSectionKey | InsertCuttingSection (Plane const &in_plane) |
| Creates a new cutting section in this segment and returns a key to it. More... | |
| CuttingSectionKey | InsertCuttingSection (CuttingSectionKit const &in_kit) |
| Creates a new cutting section in this segment and returns a key to it. More... | |
| CuttingSectionKey | InsertCuttingSection (PlaneArray const &in_planes) |
| Creates a new cutting section in this segment and returns a key to it. More... | |
| CuttingSectionKey | InsertCuttingSection (size_t in_planes_count, Plane const in_planes []) |
| Creates a new cutting section in this segment and returns a key to it. More... | |
| InfiniteLineKey | InsertInfiniteLine (InfiniteLineKit const &in_kit) |
| Creates a new infinite line geometry in this segment and returns a key to it. More... | |
| InfiniteLineKey | 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. More... | |
| SpotlightKey | InsertSpotlight (Point const &in_position, Point const &in_target) |
| Creates a new spot light geometry in this segment and returns a key to it. More... | |
| SpotlightKey | InsertSpotlight (SpotlightKit const &in_kit) |
| Creates a new spot light geometry in this segment and returns a key to it. More... | |
| NURBSCurveKey | InsertNURBSCurve (NURBSCurveKit const &in_kit) |
| Creates a new NURBS curve geometry in this segment and returns a key to it. More... | |
| NURBSCurveKey | 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. More... | |
| NURBSCurveKey | 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. More... | |
| NURBSSurfaceKey | InsertNURBSSurface (NURBSSurfaceKit const &in_kit) |
| Creates a new NURBS surface geometry in this segment and returns a key to it. More... | |
| NURBSSurfaceKey | 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. More... | |
| NURBSSurfaceKey | 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. More... | |
| NURBSSurfaceKey | 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. More... | |
| NURBSSurfaceKey | 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. More... | |
| TextKey | InsertText (TextKit const &in_kit) |
| Creates a new text geometry in this segment and returns a key to it. More... | |
| TextKey | InsertText (Point const &in_position, char const *in_text) |
| Creates a new text geometry in this segment and returns a key to it. More... | |
| GridKey | InsertGrid (GridKit const &in_kit) |
| Creates a new grid in this segment and returns a key to it. More... | |
| GridKey | 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. More... | |
| LineKey | 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. More... | |
| LineKey | 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. More... | |
| LineKey | 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. More... | |
| LineKey | 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. More... | |
| LineKey | 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. More... | |
| LineKey | 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. More... | |
| ShellKey | InsertShellFromGeometry (SphereKey const &in_sphere) |
| Creates a new shell geometry in this segment which approximates the given sphere and returns a key to it. More... | |
| ShellKey | InsertShellFromGeometry (CylinderKey const &in_cylinder) |
| Creates a new shell geometry in this segment which approximates the given cylinder and returns a key to it. More... | |
| ShellKey | 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. More... | |
| ShellKey | InsertShellFromGeometry (MeshKey const &in_mesh) |
| Creates a new shell geometry in this segment which approximates the given mesh and returns a key to it. More... | |
| ShellKey | InsertShellFromGeometry (PolygonKey const &in_polygon) |
| Creates a new shell geometry in this segment which approximates the given polygon and returns a key to it. More... | |
| ShellKey | InsertShellFromGeometry (EllipseKey const &in_ellipse) |
| Creates a new shell geometry in this segment which approximates the given ellipse and returns a key to it. More... | |
| ShellKey | InsertShellFromGeometry (CircleKey const &in_circle) |
| Creates a new shell geometry in this segment which approximates the given circle and returns a key to it. More... | |
| ShellKey | InsertShellFromGeometry (CircularWedgeKey const &in_circular_wedge) |
| Creates a new shell geometry in this segment which approximates the given circular wedge and returns a key to it. More... | |
| ShellKey | InsertShellFromGeometry (TextKey const &in_text) |
| Creates a new shell geometry in this segment which approximates the given text and returns a key to it. More... | |
| SegmentKey & | SetAttributeLock (AttributeLockKit const &in_kit) |
| Sets the attribute locks designated by in_kit on this segment. More... | |
| bool | ShowAttributeLock (AttributeLockKit &out_kit) const |
| Shows the attribute locks settings on this segment. More... | |
| AttributeLockControl | GetAttributeLockControl () |
| Returns a control that allows the user to manipulate and query details of the attribute locks on this segment. More... | |
| AttributeLockControl const | GetAttributeLockControl () const |
| Returns a control that allows the user to manipulate and query details of the attribute locks on this segment. More... | |
| SegmentKey & | SetBounding (BoundingKit const &in_kit) |
| Sets the bounding designated by in_kit on this segment. More... | |
| SegmentKey & | UnsetBounding () |
| Removes all bounding settings from this segment. More... | |
| bool | ShowBounding (BoundingKit &out_kit) const |
| Shows the bounding or bounding settings on this segment. More... | |
| BoundingControl | GetBoundingControl () |
| Returns a control that allows the user to manipulate and query details of the bounding control on this segment. More... | |
| BoundingControl const | GetBoundingControl () const |
| Returns a control that allows the user to manipulate and query details of the bounding control on this segment. More... | |
| SegmentKey & | SetCamera (CameraKit const &in_kit) |
| Sets the camera attribute designated by in_kit on this segment. More... | |
| bool | ShowCamera (CameraKit &out_kit) const |
| Shows the camera attribute settings on this segment. More... | |
| CameraControl | GetCameraControl () |
| CameraControl const | GetCameraControl () const |
| SegmentKey & | SetColorInterpolation (ColorInterpolationKit const &in_kit) |
| Sets the color interpolation attributes designated by in_kit on this segment. More... | |
| bool | ShowColorInterpolation (ColorInterpolationKit &out_kit) const |
| Shows the color interpolation attribute settings on this segment. More... | |
| ColorInterpolationControl | GetColorInterpolationControl () |
| ColorInterpolationControl const | GetColorInterpolationControl () const |
| SegmentKey & | SetContourLine (ContourLineKit const &in_kit) |
| Sets the contour line attributes designated by in_kit on this segment. More... | |
| bool | ShowContourLine (ContourLineKit &out_kit) const |
| Shows the contour line attribute settings on this segment. More... | |
| ContourLineControl | GetContourLineControl () |
| ContourLineControl const | GetContourLineControl () const |
| SegmentKey & | SetCulling (CullingKit const &in_kit) |
| Sets the culling attributes designated by in_kit on this segment. More... | |
| bool | ShowCulling (CullingKit &out_kit) const |
| Shows the culling attribute settings on this segment. More... | |
| CullingControl | GetCullingControl () |
| Returns a control that allows the user to manipulate and query details of the culling attribute on this segment. More... | |
| CullingControl const | GetCullingControl () const |
| Returns a control that allows the user to manipulate and query details of the culling attribute on this segment. More... | |
| SegmentKey & | SetCurveAttribute (CurveAttributeKit const &in_kit) |
| Sets the curve attributes designated by in_kit on this segment. More... | |
| bool | ShowCurveAttribute (CurveAttributeKit &out_kit) const |
| Shows the curve attribute settings on this segment. More... | |
| CurveAttributeControl | GetCurveAttributeControl () |
| Returns a control that allows the user to manipulate and query details of the curve attribute on this segment. More... | |
| CurveAttributeControl const | GetCurveAttributeControl () const |
| Returns a control that allows the user to manipulate and query details of the curve attribute on this segment. More... | |
| SegmentKey & | SetCuttingSectionAttribute (CuttingSectionAttributeKit const &in_kit) |
| Sets the cutting section attributes designated by in_kit on this segment. More... | |
| bool | ShowCuttingSectionAttribute (CuttingSectionAttributeKit &out_kit) const |
| Shows the cutting section attribute settings on this segment. More... | |
| CuttingSectionAttributeControl | GetCuttingSectionAttributeControl () |
| Returns a control that allows the user to manipulate and query details of the cutting section attributes on this segment. More... | |
| CuttingSectionAttributeControl const | GetCuttingSectionAttributeControl () const |
| Returns a control that allows the user to manipulate and query details of the cutting section attributes on this segment. More... | |
| SegmentKey & | SetCylinderAttribute (CylinderAttributeKit const &in_kit) |
| Sets the cylinder attributes designated by in_kit on this segment. More... | |
| bool | ShowCylinderAttribute (CylinderAttributeKit &out_kit) const |
| Shows the cylinder attribute settings on this segment. More... | |
| CylinderAttributeControl | GetCylinderAttributeControl () |
| Returns a control that allows the user to manipulate and query details of the cylinder attribute on this segment. More... | |
| CylinderAttributeControl const | GetCylinderAttributeControl () const |
| Returns a control that allows the user to manipulate and query details of the cylinder attribute on this segment. More... | |
| SegmentKey & | SetDrawingAttribute (DrawingAttributeKit const &in_kit) |
| Sets the drawing attributes designated by in_kit on this segment. More... | |
| bool | ShowDrawingAttribute (DrawingAttributeKit &out_kit) const |
| Shows the drawing attribute settings on this segment. More... | |
| DrawingAttributeControl | GetDrawingAttributeControl () |
| Returns a control that allows the user to manipulate and query details of the drawing attribute on this segment. More... | |
| DrawingAttributeControl const | GetDrawingAttributeControl () const |
| Returns a control that allows the user to manipulate and query details of the drawing attribute on this segment. More... | |
| SegmentKey & | SetEdgeAttribute (EdgeAttributeKit const &in_kit) |
| Sets the edge attributes designated by in_kit on this segment. More... | |
| bool | ShowEdgeAttribute (EdgeAttributeKit &out_kit) const |
| Shows the edge attribute settings on this segment. More... | |
| EdgeAttributeControl | GetEdgeAttributeControl () |
| Returns a control that allows the user to manipulate and query details of the edge attribute on this segment. More... | |
| EdgeAttributeControl const | GetEdgeAttributeControl () const |
| Returns a control that allows the user to manipulate and query details of the edge attribute on this segment. More... | |
| SegmentKey & | SetHiddenLineAttribute (HiddenLineAttributeKit const &in_kit) |
| Sets the hidden line attributes designated by in_kit on this segment. More... | |
| bool | ShowHiddenLineAttribute (HiddenLineAttributeKit &out_kit) const |
| Shows the hidden line attribute settings on this segment. More... | |
| HiddenLineAttributeControl | GetHiddenLineAttributeControl () |
| Returns a control that allows the user to manipulate and query details of the hidden line attribute on this segment. More... | |
| HiddenLineAttributeControl const | GetHiddenLineAttributeControl () const |
| Returns a control that allows the user to manipulate and query details of the hidden line attribute on this segment. More... | |
| SegmentKey & | SetLightingAttribute (LightingAttributeKit const &in_kit) |
| Sets the lighting attributes designated by in_kit on this segment. More... | |
| bool | ShowLightingAttribute (LightingAttributeKit &out_kit) const |
| Shows the lighting attribute settings on this segment. More... | |
| LightingAttributeControl | GetLightingAttributeControl () |
| Returns a control that allows the user to manipulate and query details of the lighting attribute on this segment. More... | |
| LightingAttributeControl const | GetLightingAttributeControl () const |
| Returns a control that allows the user to manipulate and query details of the lighting attribute on this segment. More... | |
| SegmentKey & | SetLineAttribute (LineAttributeKit const &in_kit) |
| Sets the line attributes designated by in_kit on this segment. More... | |
| bool | ShowLineAttribute (LineAttributeKit &out_kit) const |
| Shows the line attribute settings on this segment. More... | |
| LineAttributeControl | GetLineAttributeControl () |
| Returns a control that allows the user to manipulate and query details of the line attribute on this segment. More... | |
| LineAttributeControl const | GetLineAttributeControl () const |
| Returns a control that allows the user to manipulate and query details of the line attribute on this segment. More... | |
| SegmentKey & | SetMaterialMapping (MaterialMappingKit const &in_kit) |
| Sets the material mappings designated by in_kit on this segment. More... | |
| bool | ShowMaterialMapping (MaterialMappingKit &out_kit) const |
| Shows the material mapping settings on this segment. More... | |
| MaterialMappingControl | GetMaterialMappingControl () |
| Returns a control that allows the user to manipulate and query details of the material mapping on this segment. More... | |
| MaterialMappingControl const | GetMaterialMappingControl () const |
| Returns a control that allows the user to manipulate and query details of the material mapping on this segment. More... | |
| SegmentKey & | SetMarkerAttribute (MarkerAttributeKit const &in_kit) |
| Sets the marker attributes designated by in_kit on this segment. More... | |
| bool | ShowMarkerAttribute (MarkerAttributeKit &out_kit) const |
| Shows the marker attribute settings on this segment. More... | |
| MarkerAttributeControl | GetMarkerAttributeControl () |
| Returns a control that allows the user to manipulate and query details of the marker attribute on this segment. More... | |
| MarkerAttributeControl const | GetMarkerAttributeControl () const |
| Returns a control that allows the user to manipulate and query details of the marker attribute on this segment. More... | |
| SegmentKey & | SetModellingMatrix (MatrixKit const &in_kit) |
| Sets the modelling matrix attributes designated by in_kit on this segment. More... | |
| bool | ShowModellingMatrix (MatrixKit &out_kit) const |
| Shows the modelling matrix setting on this segment. More... | |
| ModellingMatrixControl | GetModellingMatrixControl () |
| Returns a control that allows the user to manipulate and query details of the modelling matrix on this segment. More... | |
| ModellingMatrixControl const | GetModellingMatrixControl () const |
| Returns a control that allows the user to manipulate and query details of the modelling matrix on this segment. More... | |
| SegmentKey & | SetNURBSSurfaceAttribute (NURBSSurfaceAttributeKit const &in_kit) |
| Sets the NURBS surface attributes designated by in_kit on this segment. More... | |
| bool | ShowNURBSSurfaceAttribute (NURBSSurfaceAttributeKit &out_kit) const |
| Shows the NURBS surface attribute settings on this segment. More... | |
| NURBSSurfaceAttributeControl | GetNURBSSurfaceAttributeControl () |
| Returns a control that allows the user to manipulate and query details of the NURBS surface attribute on this segment. More... | |
| NURBSSurfaceAttributeControl const | GetNURBSSurfaceAttributeControl () const |
| Returns a control that allows the user to manipulate and query details of the NURBS surface attribute on this segment. More... | |
| SegmentKey & | SetPerformance (PerformanceKit const &in_kit) |
| Sets the performance attributes designated by in_kit on this segment. More... | |
| bool | ShowPerformance (PerformanceKit &out_kit) const |
| Shows the performance attribute settings on this segment. More... | |
| PerformanceControl | GetPerformanceControl () |
| Returns a control that allows the user to manipulate and query details of the performance attribute on this segment. More... | |
| PerformanceControl const | GetPerformanceControl () const |
| Returns a control that allows the user to manipulate and query details of the performance attribute on this segment. More... | |
| SegmentKey & | SetSelectability (SelectabilityKit const &in_kit) |
| Sets the selectability attributes designated by in_kit on this segment. More... | |
| bool | ShowSelectability (SelectabilityKit &out_kit) const |
| Shows the selectability attribute settings on this segment. More... | |
| SelectabilityControl | GetSelectabilityControl () |
| Returns a control that allows the user to manipulate and query details of the selectability attribute on this segment. More... | |
| SelectabilityControl const | GetSelectabilityControl () const |
| Returns a control that allows the user to manipulate and query details of the selectability attribute on this segment. More... | |
| SegmentKey & | SetSphereAttribute (SphereAttributeKit const &in_kit) |
| Sets the sphere attributes designated by in_kit on this segment. More... | |
| bool | ShowSphereAttribute (SphereAttributeKit &out_kit) const |
| Shows the sphere attribute settings on this segment. More... | |
| SphereAttributeControl | GetSphereAttributeControl () |
| Returns a control that allows the user to manipulate and query details of the sphere attribute on this segment. More... | |
| SphereAttributeControl const | GetSphereAttributeControl () const |
| Returns a control that allows the user to manipulate and query details of the sphere attribute on this segment. More... | |
| SegmentKey & | SetSubwindow (SubwindowKit const &in_kit) |
| Sets the subwindow attributes designated by in_kit on this segment. More... | |
| bool | ShowSubwindow (SubwindowKit &out_kit) const |
| Shows the subwindow attribute settings on this segment. More... | |
| SubwindowControl | GetSubwindowControl () |
| Returns a control that allows the user to manipulate and query details of the subwindow attribute on this segment. More... | |
| SubwindowControl const | GetSubwindowControl () const |
| Returns a control that allows the user to manipulate and query details of the subwindow attribute on this segment. More... | |
| SegmentKey & | SetTextAttribute (TextAttributeKit const &in_kit) |
| Sets the text attributes designated by in_kit on this segment. More... | |
| bool | ShowTextAttribute (TextAttributeKit &out_kit) const |
| Shows the text attribute settings on this segment. More... | |
| TextAttributeControl | GetTextAttributeControl () |
| Returns a control that allows the user to manipulate and query details of the text attribute on this segment. More... | |
| TextAttributeControl const | GetTextAttributeControl () const |
| Returns a control that allows the user to manipulate and query details of the text attribute on this segment. More... | |
| SegmentKey & | SetTextureMatrix (MatrixKit const &in_kit) |
| Sets the texture matrix attributes designated by in_kit on this segment. More... | |
| bool | ShowTextureMatrix (MatrixKit &out_kit) const |
| Shows the texture matrix setting on this segment. More... | |
| TextureMatrixControl | GetTextureMatrixControl () |
| Returns a control that allows the user to manipulate and query details of the texture matrix on this segment. More... | |
| TextureMatrixControl const | GetTextureMatrixControl () const |
| Returns a control that allows the user to manipulate and query details of the texture matrix on this segment. More... | |
| SegmentKey & | SetTransformMask (TransformMaskKit const &in_kit) |
| Sets the transform mask designated by in_kit on this segment. More... | |
| bool | ShowTransformMask (TransformMaskKit &out_kit) const |
| Shows the transform mask settings on this segment. More... | |
| TransformMaskControl | GetTransformMaskControl () |
| Returns a control that allows the user to manipulate and query details of the transform mask on this segment. More... | |
| TransformMaskControl const | GetTransformMaskControl () const |
| Returns a control that allows the user to manipulate and query details of the transform mask on this segment. More... | |
| SegmentKey & | SetTransparency (TransparencyKit const &in_kit) |
| Sets the transparency attributes designated by in_kit on this segment. More... | |
| bool | ShowTransparency (TransparencyKit &out_kit) const |
| Shows the transparency attribute settings on this segment. More... | |
| TransparencyControl | GetTransparencyControl () |
| Returns a control that allows the user to manipulate and query details of the transparency attribute on this segment. More... | |
| TransparencyControl const | GetTransparencyControl () const |
| Returns a control that allows the user to manipulate and query details of the transparency attribute on this segment. More... | |
| SegmentKey & | SetVisibility (VisibilityKit const &in_kit) |
| Sets the visibility attribute designated by in_kit on this segment. More... | |
| bool | ShowVisibility (VisibilityKit &out_kit) const |
| Shows the visibility attribute settings on this segment. More... | |
| VisibilityControl | GetVisibilityControl () |
| Returns a control that allows the user to manipulate and query details of the visibility attribute on this segment. More... | |
| VisibilityControl const | GetVisibilityControl () const |
| Returns a control that allows the user to manipulate and query details of the visibility attribute on this segment. More... | |
| SegmentKey & | SetVisualEffects (VisualEffectsKit const &in_kit) |
| Sets the visual effects attributes designated by in_kit on this segment. More... | |
| bool | ShowVisualEffects (VisualEffectsKit &out_kit) const |
| Shows the visual effects attribute settings on this segment. More... | |
| VisualEffectsControl | GetVisualEffectsControl () |
| Returns a control that allows the user to manipulate and query details of the visual effects attribute on this segment. More... | |
| VisualEffectsControl const | GetVisualEffectsControl () const |
| Returns a control that allows the user to manipulate and query details of the visual effects attribute on this segment. More... | |
| void | Optimize (SegmentOptimizationOptionsKit const &in_kit) |
| Optimizes this Segment according to the options specified in the SegmentOptimizationOptionsKit. More... | |
| bool | HasOwner () const |
| SegmentKey | Up () const |
| SegmentKey | Owner () const |
| void | Delete () |
| Removes the database object referred to by this key. More... | |
| virtual void | Assign (Key const &in_that) |
| Share the underlying smart-pointer of the Key source. More... | |
| bool | Equals (Key const &in_that) const |
| Determines whether the database objects pointed to by this key and in_that are the same. More... | |
| bool | operator!= (Key const &in_that) const |
| Determines whether the database objects pointed to by this key and in_that are the same. More... | |
| bool | operator== (Key const &in_that) const |
| Determines whether the database objects pointed to by this key and in_that are the same. More... | |
| size_t | GetHash () const |
| Returns a hash code for the key. More... | |
| virtual HPS::Type | Type () const |
| This function returns the true type of the underlying object. More... | |
| virtual bool | Empty () const |
| Indicates whether this object has any values set on it. More... | |
| virtual void | Reset () |
| Resets this object to its initial, uninitialized state. More... | |
| bool | HasType (HPS::Type in_mask) const |
| This function indicates whether this Object has the given Type mask. More... | |
| intptr_t | GetClassID () const |
| Returns a unique identifier that is shared by all objects of the same class. More... | |
| intptr_t | GetInstanceID () const |
| Returns an identifier that can be used to identify which instance of a class an object is. More... | |
Static Public Member Functions | |
| template<typename T > | |
| static intptr_t | ClassID () |
| Unique identifier for this class. More... | |
Static Public Attributes | |
| static const HPS::Type | staticType = HPS::Type::WindowKey |
The WindowKey class is a smart pointer to a database object.
Windows are special segments that are backed by a driver instance and a physical window. Some operations and attributes can only be performed or set from window keys. The WindowKey class itself is a base class for more specific window types (application windows, off-screen windows, stand-alone windows).
| HPS::WindowKey::WindowKey | ( | ) |
An uninitialized key refers to no database object and Type() will return Type::None.
| HPS::WindowKey::WindowKey | ( | WindowKey const & | in_window | ) |
Shares a reference to a database object referred to by in_window.
| HPS::WindowKey::WindowKey | ( | WindowKey && | in_that | ) |
| HPS::WindowKey::WindowKey | ( | Key const & | in_key | ) |
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.
| HPS::WindowKey::~WindowKey | ( | ) |
Releases a reference to a database object but does not destroy the database object.
|
virtualinherited |
|
inlinestaticinherited |
Unique identifier for this class.
Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.
| bool HPS::WindowKey::ConvertCoordinate | ( | Coordinate::Space | in_space, |
| Point const & | in_point, | ||
| Coordinate::Space | in_output_space, | ||
| Point & | out_point | ||
| ) | const |
Converts the point in_point from in_space to in_output_space using the transforms associated with this window.
Returns success.
|
private |
CopyTo is private because windows cannot be copied to a segment.
|
inherited |
Removes the database object referred to by this key.
|
inherited |
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.
|
inlinevirtualinherited |
Indicates whether this object has any values set on it.
Reimplemented in HPS::STL::ImportResultsKit, HPS::STL::ImportOptionsKit, HPS::OBJ::ImportResultsKit, HPS::OBJ::ImportOptionsKit, HPS::Hardcopy::File::ExportOptionsKit, HPS::Stream::ExportOptionsKit, HPS::Stream::ImportResultsKit, HPS::Stream::ImportOptionsKit, HPS::PointCloud::ImportOptionsKit, HPS::PointCloud::ImportResultsKit, HPS::UpdateOptionsKit, HPS::HighlightSearchOptionsKit, HPS::HighlightOptionsKit, HPS::SelectionOptionsKit, HPS::SearchOptionsKit, HPS::CutGeometryGatheringOptionsKit, HPS::ShapeKit, HPS::ShaderKit, HPS::Shader::ImportOptionsKit, HPS::ImageKit, HPS::Image::ImportOptionsKit, HPS::Image::ExportOptionsKit, HPS::TextureOptionsKit, HPS::LinePatternKit, HPS::LinePatternParallelKit, HPS::LinePatternOptionsKit, HPS::GlyphKit, HPS::ApplicationWindowOptionsKit, HPS::OffScreenWindowOptionsKit, HPS::StandAloneWindowOptionsKit, HPS::GridKit, HPS::PolygonKit, HPS::MeshKit, HPS::ShellKit, HPS::ShellRelationResultsKit, HPS::ShellRelationOptionsKit, HPS::ShellOptimizationOptionsKit, HPS::TextKit, HPS::EllipticalArcKit, HPS::EllipseKit, HPS::TrimKit, HPS::NURBSSurfaceKit, HPS::NURBSCurveKit, HPS::SpotlightKit, HPS::InfiniteLineKit, HPS::CuttingSectionKit, HPS::CircularWedgeKit, HPS::CircularArcKit, HPS::CircleKit, HPS::SphereKit, HPS::CylinderKit, HPS::DistantLightKit, HPS::MarkerKit, HPS::LineKit, HPS::AttributeLockKit, HPS::FontInfoState, HPS::WindowInfoKit, HPS::DebuggingKit, HPS::SubwindowKit, HPS::ContourLineKit, HPS::VisualEffectsKit, HPS::TransformMaskKit, HPS::PostProcessEffectsKit, HPS::DrawingAttributeKit, HPS::HiddenLineAttributeKit, HPS::PerformanceKit, HPS::NURBSSurfaceAttributeKit, HPS::MaterialKit, HPS::MaterialMappingKit, HPS::MatrixKit, HPS::CurveAttributeKit, HPS::EdgeAttributeKit, HPS::LineAttributeKit, HPS::TextAttributeKit, HPS::CuttingSectionAttributeKit, HPS::CylinderAttributeKit, HPS::LightingAttributeKit, HPS::SphereAttributeKit, HPS::MarkerAttributeKit, HPS::CullingKit, HPS::ColorInterpolationKit, HPS::TransparencyKit, HPS::SelectabilityKit, HPS::CameraKit, HPS::VisibilityKit, HPS::BoundingKit, HPS::SegmentOptimizationOptionsKit, HPS::Publish::ExportOptionsKit, HPS::Publish::TextFieldKit, HPS::Publish::SignatureFieldKit, HPS::Publish::DropDownListKit, HPS::Exchange::TessellationOptionsKit, HPS::Publish::ListBoxKit, HPS::Exchange::ExportSTEPOptionsKit, HPS::Exchange::ExportParasolidOptionsKit, HPS::Publish::RadioButtonKit, HPS::Exchange::ExportIGESOptionsKit, HPS::Exchange::ExportXMLOptionsKit, HPS::Publish::CheckBoxKit, HPS::Exchange::ExportU3DOptionsKit, HPS::Exchange::ExportSTLOptionsKit, HPS::Publish::ButtonKit, HPS::Exchange::ExportPRCOptionsKit, HPS::Publish::LinkKit, HPS::Exchange::ExportJTOptionsKit, HPS::Publish::SlideTableKit, HPS::Exchange::ExportACISOptionsKit, HPS::Publish::TableKit, HPS::Exchange::Export3MFOptionsKit, HPS::Publish::ImageKit, HPS::Publish::TextKit, HPS::Exchange::ModelFileImportOptionsKit, HPS::Publish::ViewKit, HPS::Exchange::TranslationOptionsKit, HPS::Publish::ArtworkKit, HPS::Publish::AnnotationKit, HPS::ComponentPath, HPS::Exchange::ImportOptionsKit, HPS::Parasolid::ExportOptionsKit, HPS::Exchange::NURBSConversionOptionsKit, HPS::Parasolid::LineTessellationKit, HPS::Exchange::Configuration, HPS::Publish::PageKit, HPS::Parasolid::FacetTessellationKit, HPS::Publish::DocumentKit, HPS::Parasolid::ImportOptionsKit, HPS::DWG::ImportOptionsKit, HPS::OOC::ImportOptionsKit, HPS::Sketchup::ImportOptionsKit, and HPS::Sketchup::ImportResultsKit.
|
inherited |
Determines whether the database objects pointed to by this key and in_that are the same.
Empty keys (when key.Empty() returns true) are never equal to any key, even when the key is compared against itself (they act analogously to NaN comparisons in this case.)
|
inherited |
Searches in_search_space for in_request and returns a handle to the results.
|
inherited |
Searches in_search_space for in_request and returns a handle to the results.
|
inherited |
Searches in_search_space for in_request and returns a handle to the results.
|
inherited |
Searches starting at this segment using in_options and writes found objects into out_results, returns count.
|
inherited |
Searches starting at this segment using in_options, returns count.
| size_t HPS::WindowKey::FindFonts | ( | FontSearchResults & | out_results | ) | const |
Searches the system for fonts.
| out_results | Out parameter that contains results of the font search |
| size_t HPS::WindowKey::FindHighlights | ( | HighlightSearchOptionsKit const & | in_options, |
| HighlightSearchResults & | out_results | ||
| ) | const |
Searches for any highlights under this WindowKey.
| in_options | Search options constraining what type of highlights to look for. If this is empty, all highlights will be returned. |
| out_results | The key paths under the window that are highlighted with the given search options. |
| size_t HPS::WindowKey::FindHighlights | ( | KeyPath const & | in_key_path, |
| HPS::HighlightSearch::Scope | in_scope, | ||
| HighlightSearchOptionsKit const & | in_options, | ||
| HighlightSearchResults & | out_results | ||
| ) | const |
Searches for any highlights under this WindowKey.
| in_key_path | The key path to scope this highlight search by. |
| in_scope | Determines how the scope is interpreted during a highlight search. |
| in_options | Search options constraining what type of highlights to look for. If this is empty, all highlights will be returned. |
| out_results | The key paths under the window that are highlighted with the given search options. |
|
inherited |
Searches in_search_space for in_type_to_remove and deletes all instances from the segment(s).
|
inherited |
Searches in_search_space for in_types_to_remove and deletes all instances from the segment(s).
|
inherited |
Searches in_search_space for in_types_to_remove and deletes all instances from the segment(s).
|
inherited |
Returns a control that allows the user to manipulate and query details of the attribute locks on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the attribute locks on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the bounding control on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the bounding control on this segment.
|
inherited |
|
inherited |
|
inherited |
Returns a unique identifier that is shared by all objects of the same class.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
Returns a control that allows the user to manipulate and query details of the culling attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the culling attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the curve attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the curve attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the cutting section attributes on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the cutting section attributes on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the cylinder attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the cylinder attribute on this segment.
| DebuggingControl HPS::WindowKey::GetDebuggingControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the debugging attribute on this segment.
| DebuggingControl const HPS::WindowKey::GetDebuggingControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the debugging attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the drawing attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the drawing attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the edge attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the edge attribute on this segment.
| EventDispatcher& HPS::WindowKey::GetEventDispatcher | ( | ) |
Returns a control that allows the user to interact with events in various ways.
| EventDispatcher const& HPS::WindowKey::GetEventDispatcher | ( | ) | const |
Returns a control that allows the user to interact with events in various ways.
|
inherited |
Returns a hash code for the key.
|
inherited |
Returns a control that allows the user to manipulate and query details of the hidden line attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the hidden line attribute on this segment.
| HighlightControl HPS::WindowKey::GetHighlightControl | ( | ) |
Returns a control that allows the user to highlight segments or geometry in this window.
| HighlightControl const HPS::WindowKey::GetHighlightControl | ( | ) | const |
Returns a control that allows the user to highlight segments or geometry in this window.
|
inherited |
Returns an identifier that can be used to identify which instance of a class an object is.
Different keys and controls will return the same value if they are backed by the same database resource.
|
inherited |
Returns a control that allows the user to manipulate and query details of the lighting attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the lighting attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the line attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the line attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the marker attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the marker attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the material mapping on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the material mapping on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the modelling matrix on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the modelling matrix on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the NURBS surface attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the NURBS surface attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the performance attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the performance attribute on this segment.
|
inherited |
|
inherited |
| PostProcessEffectsControl HPS::WindowKey::GetPostProcessEffectsControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the post-process effects attribute on this segment.
| PostProcessEffectsControl const HPS::WindowKey::GetPostProcessEffectsControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the post-process effects attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the selectability attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the selectability attribute on this segment.
| SelectionControl HPS::WindowKey::GetSelectionControl | ( | ) |
Returns a control that allows the user to perform selections in this window.
| SelectionControl const HPS::WindowKey::GetSelectionControl | ( | ) | const |
Returns a control that allows the user to perform selections in this window.
| SelectionOptionsControl HPS::WindowKey::GetSelectionOptionsControl | ( | ) |
Returns a control that allows the user to manipulate and query details of the selection options on this window.
| SelectionOptionsControl const HPS::WindowKey::GetSelectionOptionsControl | ( | ) | const |
Returns a control that allows the user to manipulate and query details of the selection options on this window.
|
inherited |
Returns a control that allows the user to manipulate and query details of the sphere attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the sphere attribute on this segment.
|
inherited |
|
inherited |
|
inherited |
Returns a control that allows the user to manipulate and query details of the subwindow attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the subwindow attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the text attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the text attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the texture matrix on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the texture matrix on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the transform mask on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the transform mask on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the transparency attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the transparency attribute on this segment.
| UpdateOptionsControl HPS::WindowKey::GetUpdateOptionsControl | ( | ) |
Returns a control that allows the user to change update options in this window.
| UpdateOptionsControl const HPS::WindowKey::GetUpdateOptionsControl | ( | ) | const |
Returns a control that allows the user to change update options in this window.
|
inherited |
Returns a control that allows the user to manipulate and query details of the visibility attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the visibility attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the visual effects attribute on this segment.
|
inherited |
Returns a control that allows the user to manipulate and query details of the visual effects attribute on this segment.
| WindowInfoControl const HPS::WindowKey::GetWindowInfoControl | ( | ) | const |
Returns a control that allows the user to query various window properties, including size, aspect ratio, resolution, etc.
|
inherited |
|
inherited |
|
inherited |
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.
|
inherited |
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.
|
inherited |
Creates a new circle geometry in this segment and returns a key to it.
|
inherited |
Creates a new circle geometry in this segment and returns a key to it.
|
inherited |
Creates a new circular arc geometry in this segment and returns a key to it.
|
inherited |
Creates a new circular arc geometry in this segment and returns a key to it.
|
inherited |
Creates a new circular wedge geometry in this segment and returns a key to it.
|
inherited |
Creates a new circular wedge geometry in this segment and returns a key to it.
|
inherited |
Creates a new cutting section in this segment and returns a key to it.
|
inherited |
Creates a new cutting section in this segment and returns a key to it.
|
inherited |
Creates a new cutting section in this segment and returns a key to it.
|
inherited |
Creates a new cutting section in this segment and returns a key to it.
|
inherited |
Creates a new cylinder geometry in this segment and returns a key to it.
|
inherited |
Creates a new cylinder geometry in this segment and returns a key to it.
|
inherited |
Creates a new cylinder geometry in this segment and returns a key to it.
|
inherited |
Creates a new cylinder geometry in this segment and returns a key to it.
|
inherited |
Creates a new distant light geometry in this segment and returns a key to it.
|
inherited |
Creates a new distant light geometry in this segment and returns a key to it.
|
inherited |
Creates a new ellipse geometry in this segment and returns a key to it.
|
inherited |
Creates a new ellipse geometry in this segment and returns a key to it.
|
inherited |
Creates a new elliptical arc geometry in this segment and returns a key to it.
|
inherited |
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.
|
inherited |
Creates a new grid in this segment and returns a key to it.
|
inherited |
Creates a new infinite line geometry in this segment and returns a key to it.
|
inherited |
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.
|
inherited |
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.
|
inherited |
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. |
|
inherited |
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. |
|
inherited |
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. |
|
inherited |
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. |
|
inherited |
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. |
|
inherited |
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.
|
inherited |
Creates a new mesh geometry in this segment and returns a key to it.
|
inherited |
Creates a new mesh geometry in this segment and returns a key to it.
|
inherited |
Creates a new NURBS curve geometry in this segment and returns a key to it.
|
inherited |
Creates a new NURBS curve geometry in this segment and returns a key to it.
|
inherited |
Creates a new NURBS curve geometry in this segment and returns a key to it.
|
inherited |
Creates a new NURBS surface geometry in this segment and returns a key to it.
|
inherited |
Creates a new NURBS surface geometry in this segment and returns a key to it.
|
inherited |
Creates a new NURBS surface geometry in this segment and returns a key to it.
|
inherited |
Creates a new NURBS surface geometry in this segment and returns a key to it.
|
inherited |
Creates a new NURBS surface geometry in this segment and returns a key to it.
|
inherited |
Creates a new polygon geometry in this segment and returns a key to it.
|
inherited |
Creates a new polygon geometry in this segment and returns a key to it.
|
inherited |
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.
|
inherited |
Creates a new shell geometry in this segment and returns a key to it.
|
inherited |
Creates a new shell geometry in this segment and returns a key to it.
|
inherited |
Creates a new shell geometry in this segment and then returns a key to it.
| 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 }; |
|
inherited |
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. |
|
inherited |
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. |
|
inherited |
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. |
|
inherited |
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. |
|
inherited |
Creates a new shell 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 shell approximation. |
Creates a new shell 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 shell approximation. |
|
inherited |
Creates a new shell 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 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 |
|
inherited |
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) |
|
inherited |
Creates a new spot light geometry in this segment and returns a key to it.
|
inherited |
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. |
|
private |
MoveTo is private because windows cannot be moved to a segment.
|
inherited |
Returns the name given to this segment when it was created.
|
inlinevirtual |
Reimplemented from HPS::SegmentKey.
Reimplemented in HPS::OffScreenWindowKey, HPS::ApplicationWindowKey, and HPS::StandAloneWindowKey.
|
inherited |
Determines whether the database objects pointed to by this key and in_that are the same.
Copy assignment operator for WindowKey.
|
inherited |
Determines whether the database objects pointed to by this key and in_that are the same.
|
inherited |
Optimizes this Segment according to the options specified in the SegmentOptimizationOptionsKit.
| in_kit | A SegmentOptimizationOptionsKit that specifies how the Segment should be optimized. |
|
inherited |
|
inherited |
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. |
|
inherited |
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_conditional | A conditional expression which will determine whether the referenced geometry gets drawn for this segment. |
|
virtualinherited |
Resets this object to its initial, uninitialized state.
Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.
|
inherited |
Sets the attribute locks designated by in_kit on this segment.
|
inherited |
Sets the bounding designated by in_kit on this segment.
|
inherited |
Sets the camera attribute designated by in_kit on this segment.
|
inherited |
Sets the color interpolation attributes designated by in_kit on this segment.
|
inherited |
Sets in_condition as the only condition on this segment, replacing any existing conditions.
|
inherited |
Sets in_conditions as the only conditions on this segment, replacing any existing conditions.
|
inherited |
Sets in_conditions as the only conditions on this segment, replacing any existing conditions.
|
inherited |
Sets the contour line attributes designated by in_kit on this segment.
|
inherited |
Sets the culling attributes designated by in_kit on this segment.
|
inherited |
Sets the curve attributes designated by in_kit on this segment.
|
inherited |
Sets the cutting section attributes designated by in_kit on this segment.
|
inherited |
Sets the cylinder attributes designated by in_kit on this segment.
| WindowKey& HPS::WindowKey::SetDebugging | ( | DebuggingKit const & | in_kit | ) |
Sets the debugging attributes designated by in_kit on this segment.
|
inherited |
Sets the drawing attributes designated by in_kit on this segment.
| WindowKey& HPS::WindowKey::SetDriverEventHandler | ( | DriverEventHandler const & | in_handler, |
| intptr_t | in_type | ||
| ) |
Sets the specified driver event handler as the handler for the specified driver event type on this window.
| in_handler | Driver event handler to be set. |
| in_type | Type of driver event to add the handler for. |
|
inherited |
Sets the edge attributes designated by in_kit on this segment.
|
inherited |
Sets the hidden line attributes designated by in_kit on this segment.
|
inherited |
Sets the lighting attributes designated by in_kit on this segment.
|
inherited |
Sets the line attributes designated by in_kit on this segment.
|
inherited |
Sets the marker attributes designated by in_kit on this segment.
|
inherited |
Sets the material mappings designated by in_kit on this segment.
|
inherited |
Applies the material palette associated with in_name to this segment, replacing any existing material palette.
|
inherited |
Sets the modelling matrix attributes designated by in_kit on this segment.
|
inherited |
Sets the new name of this segment.
|
inherited |
Sets the NURBS surface attributes designated by in_kit on this segment.
|
inherited |
Sets the performance attributes designated by in_kit on this segment.
| WindowKey& HPS::WindowKey::SetPostProcessEffects | ( | PostProcessEffectsKit const & | in_kit | ) |
Sets the post-process effects attributes designated by in_kit on this segment.
|
inherited |
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. |
|
inherited |
Sets the selectability attributes designated by in_kit on this segment.
| WindowKey& HPS::WindowKey::SetSelectionOptions | ( | SelectionOptionsKit const & | in_kit | ) |
Sets the options that will be used by default for selections performed from this window.
Note: these options cannot be unset.
|
inherited |
Sets the sphere attributes designated by in_kit on this segment.
|
inherited |
Sets the subwindow attributes designated by in_kit on this segment.
|
inherited |
Sets the text attributes designated by in_kit on this segment.
|
inherited |
Sets the texture matrix attributes designated by in_kit on this segment.
|
inherited |
Sets the transform mask designated by in_kit on this segment.
|
inherited |
Sets the transparency attributes designated by in_kit on this segment.
| WindowKey& HPS::WindowKey::SetUpdateOptions | ( | HPS::UpdateOptionsKit const & | in_kit | ) |
Sets the options that will be used by default for update options performed from this window.
Note: these options cannot be unset.
|
inherited |
Sets user data on this key.
| in_indices | An array of user data indices to set. |
| in_data | An array of bytes of user data to set. |
|
inherited |
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. |
|
inherited |
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. |
|
inherited |
Sets the visibility attribute designated by in_kit on this segment.
|
inherited |
Sets the visual effects attributes designated by in_kit on this segment.
|
inherited |
Shows the attribute locks settings on this segment.
|
inherited |
Shows the bounding or bounding settings on this segment.
|
inherited |
Shows the camera attribute settings on this segment.
Returns false if no camera is set on this segment.
|
inherited |
Shows the color interpolation attribute settings on this segment.
Returns false if no color interpolation attribute settings exist on this segment.
|
inherited |
Shows all conditions on this segment.
|
inherited |
Shows the contour line attribute settings on this segment.
Returns false if no contour line attribute settings exist on this segment.
|
inherited |
Shows the culling attribute settings on this segment.
|
inherited |
Shows the curve attribute settings on this segment.
Returns false if no curve attribute settings exist on this segment.
|
inherited |
Shows the cutting section attribute settings on this segment.
Returns false if no cutting section attribute settings exist on this segment.
|
inherited |
Shows the cylinder attribute settings on this segment.
Returns false if no cylinder attribute settings exist on this segment.
| bool HPS::WindowKey::ShowDebugging | ( | DebuggingKit & | out_kit | ) | const |
Shows the debugging attribute settings on this segment.
|
inherited |
Shows the drawing attribute settings on this segment.
Returns false if no drawing settings exist on this segment.
|
inherited |
Shows the edge attribute settings on this segment.
Returns false if no edge attribute settings exist on this segment.
|
inherited |
Shows the hidden line attribute settings on this segment.
Returns false if no hidden line settings exist on this segment.
|
inherited |
Shows the all the segments which contain includes of this key.
| out_segments | The list of segments which contains includes of this key. |
|
inherited |
Shows the all the includes of this key.
| out_includes | The list of all includes of this key. |
|
inherited |
Shows the lighting attribute settings on this segment.
Returns false if no lighting attribute settings exist on this segment.
|
inherited |
Shows the line attribute settings on this segment.
Returns false if no line attribute settings exist on this segment.
|
inherited |
Shows the marker attribute settings on this segment.
Returns false if no marker attribute settings exist on this segment.
|
inherited |
Shows the material mapping settings on this segment.
Returns false if no material mapping settings exist on this segment.
|
inherited |
Shows the existing material palette, if any, that is active on this segment.
|
inherited |
Shows the modelling matrix setting on this segment.
Returns false if no modelling matrix setting exists on this segment.
|
inherited |
Shows the NURBS surface attribute settings on this segment.
Returns false if no NURBS surface attribute settings exist on this segment.
|
inherited |
Shows the performance attribute settings on this segment.
Returns false if no performance settings exist on this segment.
| bool HPS::WindowKey::ShowPostProcessEffects | ( | PostProcessEffectsKit & | out_kit | ) | const |
Shows the post-process effects attribute settings on this segment.
Returns false if no post-process effects attribute settings exist on this segment.
|
inherited |
Shows the drawing priority.
| out_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
|
inherited |
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. |
|
inherited |
Shows the all the references to this key.
| out_references | The list of all references to this key. |
|
inherited |
Shows the selectability attribute settings on this segment.
| bool HPS::WindowKey::ShowSelectionOptions | ( | SelectionOptionsKit & | out_kit | ) | const |
Shows the options that will be used by default for selections performed from this window.
| bool HPS::WindowKey::ShowSnapshot | ( | ImageKit & | out_kit | ) | const |
Shows the current display as an image.
Note: this will return false if an Update was never made.
| out_kit | An image kit to show the display into. |
|
inherited |
Shows the sphere attribute settings on this segment.
|
inherited |
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. |
|
inherited |
Shows the all the styles which refer to this key.
| out_styles | The list of all styles which refer to this key. |
|
inherited |
|
inherited |
|
inherited |
Shows the subwindow attribute settings on this segment.
|
inherited |
Shows the text attribute settings on this segment.
Returns false if no text attribute settings exist on this segment.
|
inherited |
Shows the texture matrix setting on this segment.
|
inherited |
Shows the transform mask settings on this segment.
|
inherited |
Shows the transparency attribute settings on this segment.
| bool HPS::WindowKey::ShowUpdateOptions | ( | HPS::UpdateOptionsKit & | out_kit | ) | const |
Shows the options that will be used by default for update options performed from this window.
|
inherited |
Shows all user data for this key.
| 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. |
|
inherited |
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. |
|
inherited |
Get the number of user data indices set on this key.
|
inherited |
Shows the indices of all user data set on this key.
| out_indices | The user data indices set on this key. |
|
inherited |
Shows the visibility attribute settings on this segment.
|
inherited |
Shows the visual effects attribute settings on this segment.
| bool HPS::WindowKey::ShowWindowInfo | ( | WindowInfoKit & | out_kit | ) | const |
|
inherited |
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.
|
virtualinherited |
This function returns the true type of the underlying object.
This function is useful for finding the type of smart pointer objects that have been cast to more generic types.
Reimplemented in HPS::UpdateOptionsControl, HPS::HighlightControl, HPS::SelectionOptionsControl, HPS::OffScreenWindowOptionsControl, HPS::ApplicationWindowOptionsControl, HPS::StandAloneWindowOptionsControl, HPS::AttributeLockControl, HPS::WindowInfoControl, HPS::DebuggingControl, HPS::SubwindowControl, HPS::ContourLineControl, HPS::VisualEffectsControl, HPS::TransformMaskControl, HPS::PostProcessEffectsControl, HPS::DrawingAttributeControl, HPS::HiddenLineAttributeControl, HPS::PerformanceControl, HPS::NURBSSurfaceAttributeControl, HPS::ConditionControl, HPS::StyleControl, HPS::PortfolioControl, HPS::MaterialMappingControl, HPS::TextureMatrixControl, HPS::ModellingMatrixControl, HPS::CurveAttributeControl, HPS::EdgeAttributeControl, HPS::LineAttributeControl, HPS::TextAttributeControl, HPS::CuttingSectionAttributeControl, HPS::CylinderAttributeControl, HPS::LightingAttributeControl, HPS::SphereAttributeControl, HPS::MarkerAttributeControl, HPS::CullingControl, HPS::ColorInterpolationControl, HPS::TransparencyControl, HPS::SelectabilityControl, HPS::CameraControl, HPS::VisibilityControl, HPS::BoundingControl, HPS::Kit, and HPS::Control.
|
inherited |
Removes all user data from this key.
|
private |
Unset methods are hidden here because default attributes cannot be unset from the window.
|
inherited |
Removes all bounding settings from this segment.
|
private |
|
private |
|
inherited |
Unsets all conditions on this segment.
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
| WindowKey& HPS::WindowKey::UnsetDriverEventHandler | ( | intptr_t | in_type | ) |
Unsets the driver event handler for the specified driver event type on this window.
| in_type | Type of driver event to remove the handler for |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
inherited |
Removes the existing material palette, if any, that is active on this segment.
|
private |
|
private |
|
private |
|
inherited |
Removes the drawing priority setting.
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
inherited |
Removes the user data at the given index from this key.
| in_index | The index of the user data to remove. |
|
inherited |
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. |
|
inherited |
Removes the user data at the given indices from this key.
| in_indices | The indices of the user data to remove. |
|
private |
|
private |
|
inherited |
| void HPS::WindowKey::Update | ( | ) |
Performs a default update in this window, redrawing and refreshing the display.
| void HPS::WindowKey::Update | ( | UpdateOptionsKit const & | in_kit | ) |
Performs an update in this window, redrawing and refreshing the display using the options in the UpdateOptionsKit.
| in_kit | Allows the user to control how thorough an update should be. |
| void HPS::WindowKey::Update | ( | Window::UpdateType | in_type, |
| Time | in_time_limit = -1 |
||
| ) |
Performs an update in this window within the specified amount of time, redrawing and refreshing the display based on the Window::UpdateType value.
Key behavioral notes regarding a timed-update:
Non-incremental rendering modes/attributes
| in_control | Allows the user to control how thorough this update should be. |
| in_time_limit | Specifies the desired maximum time this update should take. |
| UpdateNotifier HPS::WindowKey::UpdateWithNotifier | ( | ) |
Performs a default update in this window, redrawing and refreshing the display.
| UpdateNotifier HPS::WindowKey::UpdateWithNotifier | ( | HPS::UpdateOptionsKit const & | in_kit | ) |
Performs a default update in this window, redrawing and refreshing the display.
| UpdateNotifier HPS::WindowKey::UpdateWithNotifier | ( | Window::UpdateType | in_type, |
| Time | in_time_limit = -1 |
||
| ) |
Performs an update in this window, redrawing and refreshing the display.
| in_type | Allows the user to control how thorough an update should be. |
| in_time_limit | Specifies a maximum time this update should take. |
|
static |
1.8.13