Public Member Functions | List of all members
HPS::StandAloneWindowKey Class Reference

#include <hps.h>

Inheritance diagram for HPS::StandAloneWindowKey:
HPS::WindowKey HPS::SegmentKey HPS::Key HPS::Object

Public Member Functions

 StandAloneWindowKey ()
 
 StandAloneWindowKey (Key const &in_key)
 
 StandAloneWindowKey (StandAloneWindowKey const &in_that)
 
 StandAloneWindowKey (StandAloneWindowKey &&in_that)
 
StandAloneWindowKeyoperator= (StandAloneWindowKey &&in_that)
 
HPS::Type ObjectType () const
 
StandAloneWindowOptionsControl
const 
GetWindowOptionsControl () const
 
StandAloneWindowOptionsControl GetWindowOptionsControl ()
 
bool ShowWindowOptions (StandAloneWindowOptionsKit &out_kit) const
 
Window::UpdateStatus Pause ()
 
- Public Member Functions inherited from HPS::WindowKey
 WindowKey ()
 
 WindowKey (WindowKey const &in_window)
 
WindowKeyoperator= (WindowKey const &other)
 
 WindowKey (WindowKey &&in_that)
 
WindowKeyoperator= (WindowKey &&in_that)
 
 WindowKey (Key const &in_key)
 
 ~WindowKey ()
 
bool ConvertCoordinate (Coordinate::Space in_space, Point const &in_point, Coordinate::Space in_output_space, Point &out_point) const
 
r size_t FindFonts (FontSearchResults &out_results) const
 
WindowKeySetPostProcessEffects (PostProcessEffectsKit const &in_kit)
 
bool ShowPostProcessEffects (PostProcessEffectsKit &out_kit) const
 
PostProcessEffectsControl GetPostProcessEffectsControl ()
 
PostProcessEffectsControl const GetPostProcessEffectsControl () const
 
WindowKeySetDebugging (DebuggingKit const &in_kit)
 
bool ShowDebugging (DebuggingKit &out_kit) const
 
DebuggingControl GetDebuggingControl ()
 
DebuggingControl const GetDebuggingControl () const
 
WindowInfoControl const GetWindowInfoControl () const
 
bool ShowWindowInfo (WindowInfoKit &out_kit) const
 
WindowKeySetSelectionOptions (SelectionOptionsKit const &in_kit)
 
bool ShowSelectionOptions (SelectionOptionsKit &out_kit) const
 
WindowKeySetUpdateOptions (HPS::UpdateOptionsKit const &in_kit)
 
bool ShowUpdateOptions (HPS::UpdateOptionsKit &out_kit) const
 
SelectionOptionsControl GetSelectionOptionsControl ()
 
SelectionOptionsControl const GetSelectionOptionsControl () const
 
SelectionControl GetSelectionControl ()
 
SelectionControl const GetSelectionControl () const
 
HighlightControl GetHighlightControl ()
 
HighlightControl const GetHighlightControl () const
 
UpdateOptionsControl GetUpdateOptionsControl ()
 
UpdateOptionsControl const GetUpdateOptionsControl () const
 
void Update ()
 
void Update (UpdateOptionsKit const &in_kit)
 
void Update (Window::UpdateControl in_control, Time in_time_limit=-1)
 
UpdateNotifier UpdateWithNotifier ()
 
UpdateNotifier UpdateWithNotifier (HPS::UpdateOptionsKit const &in_kit)
 
UpdateNotifier UpdateWithNotifier (Window::UpdateControl in_control, Time in_time_limit=-1)
 
EventDispatcherGetEventDispatcher ()
 
EventDispatcher const & GetEventDispatcher () const
 
bool ShowSnapshot (ImageKit &out_kit) const
 
- Public Member Functions inherited from HPS::SegmentKey
 SegmentKey ()
 
 SegmentKey (SegmentKey const &in_that)
 
SegmentKeyoperator= (SegmentKey const &other)
 
 SegmentKey (SegmentKey &&in_that)
 
SegmentKeyoperator= (SegmentKey &&in_that)
 
 SegmentKey (Key const &in_that)
 
 ~SegmentKey ()
 
UTF8 Name () const
 
SegmentKeySetName (char const *in_name)
 
SegmentKey Down (char const *in_segment_name, bool in_create_if_not_present=false) const
 
SegmentKey Subsegment (char const *in_segment_name="", bool in_create_if_not_present=true) const
 
void Flush (Search::Type in_type_to_remove=Search::Type::Everything, Search::Space in_search_space=Search::Space::SegmentOnly)
 
void Flush (SearchTypeArray const &in_types_to_remove, Search::Space in_search_space=Search::Space::SegmentOnly)
 
void Flush (size_t in_types_count, Search::Type const in_types_to_remove[], Search::Space in_search_space=Search::Space::SegmentOnly)
 
size_t Find (Search::Type in_request, Search::Space in_search_space, SearchResults &out_results) const
 
size_t Find (SearchTypeArray const &in_requests, Search::Space in_search_space, SearchResults &out_results) const
 
size_t Find (size_t in_types_count, Search::Type const in_requests[], Search::Space in_search_space, SearchResults &out_results) const
 
size_t Find (SearchOptionsKit const &in_options, SearchResults &out_results) const
 
size_t Find (SearchOptionsKit const &in_options) const
 
IncludeKey IncludeSegment (SegmentKey const &in_seg)
 
IncludeKey IncludeSegment (SegmentKey const &in_seg, Condition const &in_condition)
 
ReferenceKey ReferenceGeometry (Key const &in_key)
 
ReferenceKey ReferenceGeometry (Key const &in_key, Condition const &in_condition)
 
size_t ShowSubsegments () const
 
size_t ShowSubsegments (SegmentKeyArray &out_children) const
 
size_t ShowReferrers (SegmentKeyArray &out_segments) const
 
size_t ShowReferrers (ReferenceKeyArray &out_references) const
 
size_t ShowStylers (SegmentKeyArray &out_segments) const
 
size_t ShowStylers (StyleKeyArray &out_styles) const
 
size_t ShowIncluders (SegmentKeyArray &out_segments) const
 
size_t ShowIncluders (IncludeKeyArray &out_includes) const
 
StyleControl GetStyleControl ()
 
StyleControl const GetStyleControl () const
 
PortfolioControl GetPortfolioControl ()
 
PortfolioControl const GetPortfolioControl () const
 
SegmentKeySetCondition (char const *in_condition)
 
SegmentKeySetConditions (UTF8Array const &in_conditions)
 
SegmentKeySetConditions (size_t in_count, UTF8 const in_conditions[])
 
SegmentKeyUnsetConditions ()
 
bool ShowConditions (UTF8Array &out_conditions) const
 
ConditionControl GetConditionControl ()
 
ConditionControl const GetConditionControl () const
 
SegmentKeySetMaterialPalette (char const *in_name)
 
SegmentKeyUnsetMaterialPalette ()
 
bool ShowMaterialPalette (UTF8 &out_name) const
 
SegmentKeySetPriority (int in_priority)
 
SegmentKeyUnsetPriority ()
 
bool ShowPriority (int &out_priority) const
 
SegmentKeySetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data)
 
SegmentKeySetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[])
 
SegmentKeySetUserData (intptr_t in_index, ByteArray const &in_data)
 
SegmentKeyUnsetUserData (intptr_t in_index)
 
SegmentKeyUnsetUserData (size_t in_count, intptr_t const in_indices[])
 
SegmentKeyUnsetUserData (HPS::IntPtrTArray const &in_indices)
 
SegmentKeyUnsetAllUserData ()
 
size_t ShowUserDataCount () const
 
bool ShowUserData (IntPtrTArray &out_indices, ByteArrayArray &out_data) const
 
bool ShowUserDataIndices (IntPtrTArray &out_indices) const
 
bool ShowUserData (intptr_t in_index, ByteArray &out_data) const
 
LineKey InsertLine (LineKit const &in_kit)
 
LineKey InsertLine (size_t in_count, Point const in_pts[])
 
LineKey InsertLine (PointArray const &in_pts)
 
LineKey InsertLine (Point const &pt1, Point const &pt2)
 
CylinderKey InsertCylinder (CylinderKit const &in_kit)
 
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)
 
CylinderKey InsertCylinder (PointArray const &in_points, FloatArray const &in_radii, Cylinder::Capping in_caps=Cylinder::Capping::Both)
 
CylinderKey InsertCylinder (Point const &in_point1, Point const &in_point2, float in_radius, Cylinder::Capping in_caps=Cylinder::Capping::Both)
 
SphereKey InsertSphere (SphereKit const &in_kit)
 
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))
 
CircleKey InsertCircle (CircleKit const &in_kit)
 
CircleKey InsertCircle (Point const &in_start, Point const &in_middle, Point const &in_end)
 
CircleKey InsertCircle (Point const &in_center, float in_radius, Vector const &in_normal)
 
CircularArcKey InsertCircularArc (CircularArcKit const &in_kit)
 
CircularArcKey InsertCircularArc (Point const &in_start, Point const &in_middle, Point const &in_end)
 
CircularWedgeKey InsertCircularWedge (CircularWedgeKit const &in_kit)
 
CircularWedgeKey InsertCircularWedge (Point const &in_start, Point const &in_middle, Point const &in_end)
 
EllipseKey InsertEllipse (EllipseKit const &in_kit)
 
EllipseKey InsertEllipse (Point const &in_center, Point const &in_major, Point const &in_minor)
 
EllipticalArcKey InsertEllipticalArc (EllipticalArcKit const &in_kit)
 
EllipticalArcKey InsertEllipticalArc (Point const &in_center, Point const &in_major, Point const &in_minor, float start, float end)
 
PolygonKey InsertPolygon (PolygonKit const &in_kit)
 
PolygonKey InsertPolygon (PointArray const &in_pts)
 
PolygonKey InsertPolygon (size_t in_count, Point const in_points[])
 
ShellKey InsertShell (ShellKit const &in_kit)
 
ShellKey InsertShell (PointArray const &in_points, IntArray const &in_facelist)
 
ShellKey InsertShell (size_t in_point_count, Point const in_points[], size_t in_facelist_count, int const in_facelist[])
 
ShellKey InsertShellByTristrips (PointArray const &in_points, IntArray const &in_tristrips)
 
ShellKey InsertShellByTristrips (size_t in_point_count, Point const in_points[], size_t in_tristrips_count, int const in_tristrips[])
 
MeshKey InsertMesh (MeshKit const &in_kit)
 
MeshKey InsertMesh (size_t in_rows, size_t in_columns, PointArray const &in_points)
 
MeshKey InsertMesh (size_t in_rows, size_t in_columns, size_t in_point_count, Point const in_points[])
 
MarkerKey InsertMarker (Point const &in_position)
 
MarkerKey InsertMarker (MarkerKit const &in_kit)
 
DistantLightKey InsertDistantLight (Vector const &in_direction)
 
DistantLightKey InsertDistantLight (DistantLightKit const &in_kit)
 
CuttingSectionKey InsertCuttingSection (Plane const &in_plane)
 
CuttingSectionKey InsertCuttingSection (CuttingSectionKit const &in_kit)
 
CuttingSectionKey InsertCuttingSection (PlaneArray const &in_planes)
 
CuttingSectionKey InsertCuttingSection (size_t in_planes_count, Plane const in_planes[])
 
InfiniteLineKey InsertInfiniteLine (InfiniteLineKit const &in_kit)
 
InfiniteLineKey InsertInfiniteLine (Point const &in_first, Point const &in_second, InfiniteLine::Type in_type)
 
SpotlightKey InsertSpotlight (Point const &in_position, Point const &in_target)
 
SpotlightKey InsertSpotlight (SpotlightKit const &in_kit)
 
NURBSCurveKey InsertNURBSCurve (NURBSCurveKit const &in_kit)
 
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)
 
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)
 
NURBSSurfaceKey InsertNURBSSurface (NURBSSurfaceKit const &in_kit)
 
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)
 
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[])
 
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)
 
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[])
 
TextKey InsertText (TextKit const &in_kit)
 
TextKey InsertText (Point const &in_position, char const *in_text)
 
GridKey InsertGrid (GridKit const &in_kit)
 
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)
 
LineKey InsertLineFromGeometry (CircleKey const &in_circle, float in_deviation=-1.0f)
 
LineKey InsertLineFromGeometry (CircularArcKey const &in_circular_arc, float in_deviation=-1.0f)
 
LineKey InsertLineFromGeometry (CircularWedgeKey const &in_circular_wedge, float in_deviation=-1.0f)
 
LineKey InsertLineFromGeometry (EllipseKey const &in_ellipse, float in_deviation=-1.0f)
 
LineKey InsertLineFromGeometry (EllipticalArcKey const &in_elliptical_arc, float in_deviation=-1.0f)
 
LineKey InsertLineFromGeometry (NURBSCurveKey const &in_nurbs_curve, float in_deviation=-1.0f)
 
ShellKey InsertShellFromGeometry (SphereKey const &in_sphere)
 
ShellKey InsertShellFromGeometry (CylinderKey const &in_cylinder)
 
ShellKey InsertShellFromGeometry (NURBSSurfaceKey const &in_nurbs_surface)
 
ShellKey InsertShellFromGeometry (MeshKey const &in_mesh)
 
ShellKey InsertShellFromGeometry (PolygonKey const &in_polygon)
 
ShellKey InsertShellFromGeometry (TextKey const &in_text)
 
SegmentKeySetAttributeLocks (AttributeLockKit const &in_kit)
 
SegmentKeyUnsetAttributeLocks ()
 
bool ShowAttributeLocks (AttributeLockKit &out_kit) const
 
AttributeLockControl GetAttributeLockControl ()
 
AttributeLockControl const GetAttributeLockControl () const
 
SegmentKeySetBoundings (BoundingKit const &in_kit)
 
SegmentKeyUnsetBoundings ()
 
bool ShowBoundings (BoundingKit &out_kit) const
 
BoundingControl GetBoundingControl ()
 
BoundingControl const GetBoundingControl () const
 
SegmentKeySetCamera (CameraKit const &in_kit)
 
SegmentKeyUnsetCamera ()
 
bool ShowCamera (CameraKit &out_kit) const
 
CameraControl GetCameraControl ()
 
CameraControl const GetCameraControl () const
 
SegmentKeySetColorInterpolation (ColorInterpolationKit const &in_kit)
 
SegmentKeyUnsetColorInterpolation ()
 
bool ShowColorInterpolation (ColorInterpolationKit &out_kit) const
 
ColorInterpolationControl GetColorInterpolationControl ()
 
ColorInterpolationControl const GetColorInterpolationControl () const
 
SegmentKeySetContourLine (ContourLineKit const &in_kit)
 
SegmentKeyUnsetContourLine ()
 
bool ShowContourLine (ContourLineKit &out_kit) const
 
ContourLineControl GetContourLineControl ()
 
ContourLineControl const GetContourLineControl () const
 
SegmentKeySetCulling (CullingKit const &in_kit)
 
SegmentKeyUnsetCulling ()
 
bool ShowCulling (CullingKit &out_kit) const
 
CullingControl GetCullingControl ()
 
CullingControl const GetCullingControl () const
 
SegmentKeySetCurveAttributes (CurveAttributeKit const &in_kit)
 
SegmentKeyUnsetCurveAttributes ()
 
bool ShowCurveAttributes (CurveAttributeKit &out_kit) const
 
CurveAttributeControl GetCurveAttributeControl ()
 
CurveAttributeControl const GetCurveAttributeControl () const
 
SegmentKeySetCuttingSectionAttributes (CuttingSectionAttributeKit const &in_kit)
 
SegmentKeyUnsetCuttingSectionAttributes ()
 
bool ShowCuttingSectionAttributes (CuttingSectionAttributeKit &out_kit) const
 
CuttingSectionAttributeControl GetCuttingSectionAttributeControl ()
 
CuttingSectionAttributeControl
const 
GetCuttingSectionAttributeControl () const
 
SegmentKeySetCylinderAttributes (CylinderAttributeKit const &in_kit)
 
SegmentKeyUnsetCylinderAttributes ()
 
bool ShowCylinderAttributes (CylinderAttributeKit &out_kit) const
 
CylinderAttributeControl GetCylinderAttributeControl ()
 
CylinderAttributeControl const GetCylinderAttributeControl () const
 
SegmentKeySetDrawingAttribute (DrawingAttributeKit const &in_kit)
 
SegmentKeyUnsetDrawingAttribute ()
 
bool ShowDrawingAttribute (DrawingAttributeKit &out_kit) const
 
DrawingAttributeControl GetDrawingAttributeControl ()
 
DrawingAttributeControl const GetDrawingAttributeControl () const
 
SegmentKeySetEdgeAttributes (EdgeAttributeKit const &in_kit)
 
SegmentKeyUnsetEdgeAttributes ()
 
bool ShowEdgeAttributes (EdgeAttributeKit &out_kit) const
 
EdgeAttributeControl GetEdgeAttributeControl ()
 
EdgeAttributeControl const GetEdgeAttributeControl () const
 
SegmentKeySetHiddenLineAttribute (HiddenLineAttributeKit const &in_kit)
 
SegmentKeyUnsetHiddenLineAttribute ()
 
bool ShowHiddenLineAttribute (HiddenLineAttributeKit &out_kit) const
 
HiddenLineAttributeControl GetHiddenLineAttributeControl ()
 
HiddenLineAttributeControl const GetHiddenLineAttributeControl () const
 
SegmentKeySetLightingAttributes (LightingAttributeKit const &in_kit)
 
SegmentKeyUnsetLightingAttributes ()
 
bool ShowLightingAttributes (LightingAttributeKit &out_kit) const
 
LightingAttributeControl GetLightingAttributeControl ()
 
LightingAttributeControl const GetLightingAttributeControl () const
 
SegmentKeySetLineAttributes (LineAttributeKit const &in_kit)
 
SegmentKeyUnsetLineAttributes ()
 
bool ShowLineAttributes (LineAttributeKit &out_kit) const
 
LineAttributeControl GetLineAttributeControl ()
 
LineAttributeControl const GetLineAttributeControl () const
 
SegmentKeySetMaterialMapping (MaterialMappingKit const &in_kit)
 
SegmentKeyUnsetMaterialMapping ()
 
bool ShowMaterialMapping (MaterialMappingKit &out_kit) const
 
MaterialMappingControl GetMaterialMappingControl ()
 
MaterialMappingControl const GetMaterialMappingControl () const
 
SegmentKeySetMarkerAttributes (MarkerAttributeKit const &in_kit)
 
SegmentKeyUnsetMarkerAttributes ()
 
bool ShowMarkerAttributes (MarkerAttributeKit &out_kit) const
 
MarkerAttributeControl GetMarkerAttributeControl ()
 
MarkerAttributeControl const GetMarkerAttributeControl () const
 
SegmentKeySetModellingMatrix (MatrixKit const &in_kit)
 
SegmentKeyUnsetModellingMatrix ()
 
bool ShowModellingMatrix (MatrixKit &out_kit) const
 
ModellingMatrixControl GetModellingMatrixControl ()
 
ModellingMatrixControl const GetModellingMatrixControl () const
 
SegmentKeySetNURBSSurfaceAttributes (NURBSSurfaceAttributeKit const &in_kit)
 
SegmentKeyUnsetNURBSSurfaceAttributes ()
 
bool ShowNURBSSurfaceAttributes (NURBSSurfaceAttributeKit &out_kit) const
 
NURBSSurfaceAttributeControl GetNURBSSurfaceAttributeControl ()
 
NURBSSurfaceAttributeControl const GetNURBSSurfaceAttributeControl () const
 
SegmentKeySetPerformance (PerformanceKit const &in_kit)
 
SegmentKeyUnsetPerformance ()
 
bool ShowPerformance (PerformanceKit &out_kit) const
 
PerformanceControl GetPerformanceControl ()
 
PerformanceControl const GetPerformanceControl () const
 
SegmentKeySetSelectability (SelectabilityKit const &in_kit)
 
SegmentKeyUnsetSelectability ()
 
bool ShowSelectability (SelectabilityKit &out_kit) const
 
SelectabilityControl GetSelectabilityControl ()
 
SelectabilityControl const GetSelectabilityControl () const
 
SegmentKeySetSphereAttributes (SphereAttributeKit const &in_kit)
 
SegmentKeyUnsetSphereAttributes ()
 
bool ShowSphereAttributes (SphereAttributeKit &out_kit) const
 
SphereAttributeControl GetSphereAttributeControl ()
 
SphereAttributeControl const GetSphereAttributeControl () const
 
SegmentKeySetSubwindow (SubwindowKit const &in_kit)
 
SegmentKeyUnsetSubwindow ()
 
bool ShowSubwindow (SubwindowKit &out_kit) const
 
SubwindowControl GetSubwindowControl ()
 
SubwindowControl const GetSubwindowControl () const
 
SegmentKeySetTextAttributes (TextAttributeKit const &in_kit)
 
SegmentKeyUnsetTextAttributes ()
 
bool ShowTextAttributes (TextAttributeKit &out_kit) const
 
TextAttributeControl GetTextAttributeControl ()
 
TextAttributeControl const GetTextAttributeControl () const
 
SegmentKeySetTextureMatrix (MatrixKit const &in_kit)
 
SegmentKeyUnsetTextureMatrix ()
 
bool ShowTextureMatrix (MatrixKit &out_kit) const
 
TextureMatrixControl GetTextureMatrixControl ()
 
TextureMatrixControl const GetTextureMatrixControl () const
 
SegmentKeySetTransformMask (TransformMaskKit const &in_kit)
 
SegmentKeyUnsetTransformMask ()
 
bool ShowTransformMask (TransformMaskKit &out_kit) const
 
TransformMaskControl GetTransformMaskControl ()
 
TransformMaskControl const GetTransformMaskControl () const
 
SegmentKeySetTransparency (TransparencyKit const &in_kit)
 
SegmentKeyUnsetTransparency ()
 
bool ShowTransparency (TransparencyKit &out_kit) const
 
TransparencyControl GetTransparencyControl ()
 
TransparencyControl const GetTransparencyControl () const
 
SegmentKeySetVisibility (VisibilityKit const &in_kit)
 
SegmentKeyUnsetVisibility ()
 
bool ShowVisibility (VisibilityKit &out_kit) const
 
VisibilityControl GetVisibilityControl ()
 
VisibilityControl const GetVisibilityControl () const
 
SegmentKeySetVisualEffects (VisualEffectsKit const &in_kit)
 
SegmentKeyUnsetVisualEffects ()
 
bool ShowVisualEffects (VisualEffectsKit &out_kit) const
 
VisualEffectsControl GetVisualEffectsControl ()
 
VisualEffectsControl const GetVisualEffectsControl () const
 
void Optimize (SegmentOptimizationOptionsKit const &in_kit)
 
- Public Member Functions inherited from HPS::Key
 Key ()
 
 Key (Key const &in_that)
 
 Key (Control const &in_control)
 
 Key (Key &&in_that)
 
Keyoperator= (Key &&in_that)
 
virtual ~Key ()
 
bool HasOwner () const
 
SegmentKey Up () const
 
SegmentKey Owner () const
 
void Delete ()
 
void MoveTo (SegmentKey const &in_new_owner)
 
Key CopyTo (SegmentKey const &in_destination) const
 
Keyoperator= (Key const &in_that)
 
virtual void Assign (Key const &in_that)
 
bool Equals (Key const &in_that) const
 
bool operator!= (Key const &in_that) const
 
bool operator== (Key const &in_that) const
 
size_t GetHash () const
 
- Public Member Functions inherited from HPS::Object
Objectoperator= (Object const &other_object)
 
 Object (Object &&in_that)
 
Objectoperator= (Object &&in_that)
 
HPS::Type Type () const
 
virtual bool Empty () const
 
virtual void Reset ()
 
bool HasType (HPS::Type in_mask) const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

The StandAloneWindowKey object is a handle to a stand-alone window that Visualize can draw into. Standalone windows are always directly created by Visualize. The Visualize rendering context will use the entire window for rendering. Standalone windows are only supported on Microsoft Windows and Linux platforms.

Constructor & Destructor Documentation

HPS::StandAloneWindowKey::StandAloneWindowKey ( )

The default constructor creates an uninitialized StandAloneWindowKey object. The Type() function will return Type::None.

HPS::StandAloneWindowKey::StandAloneWindowKey ( Key const &  in_key)

This constructor creates an StandAloneWindowKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of an application window. Otherwise the copy will fail and the resulting StandAloneWindowKey will be invalid.

Parameters
in_keyThe source Key to copy.
HPS::StandAloneWindowKey::StandAloneWindowKey ( StandAloneWindowKey const &  in_that)

The copy constructor creates a StandAloneWindowKey object that shares the underlying smart-pointer of the source StandAloneWindowKey.

Parameters
in_thatThe source StandAloneWindowKey to copy.
HPS::StandAloneWindowKey::StandAloneWindowKey ( StandAloneWindowKey &&  in_that)

The move constructor creates a StandAloneWindowKey by transferring the underlying impl of the rvalue reference to this StandAloneWindowKey thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a StandAloneWindowKey to take the impl from.

Member Function Documentation

StandAloneWindowOptionsControl const HPS::StandAloneWindowKey::GetWindowOptionsControl ( ) const

Gets a control that allows querying options specific to stand-alone windows.

Returns
A control that allows querying options specific to stand-alone windows.
StandAloneWindowOptionsControl HPS::StandAloneWindowKey::GetWindowOptionsControl ( )

Gets a control that allows querying options specific to stand-alone windows.

Returns
A control that allows querying options specific to stand-alone windows.
HPS::Type HPS::StandAloneWindowKey::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS::WindowKey.

StandAloneWindowKey& HPS::StandAloneWindowKey::operator= ( StandAloneWindowKey &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this StandAloneWindowKey thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to an StandAloneWindowKey to take the impl from.
Returns
A reference to this StandAloneWindowKey.
Window::UpdateStatus HPS::StandAloneWindowKey::Pause ( )

Triggers an update and puts the calling thread into a wait loop which will only be exited when a mouse, touch, or keyboard event occurs.

Returns
The status of the triggered update.
bool HPS::StandAloneWindowKey::ShowWindowOptions ( StandAloneWindowOptionsKit out_kit) const

Shows the stand-alone-window-specific options for this StandAloneWindowKey.

Parameters
out_kitThe stand-alone-window-specific options for this StandAloneWindowKey.
Returns
true if any options are set, false otherwise.

The documentation for this class was generated from the following file: