#include <hps.h>

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

Public Member Functions

bool ConvertCoordinate (Coordinate::Space in_space, Point const &in_point, Coordinate::Space in_output_space, Point &out_point) const
 
size_t FindFonts (FontSearchResults &out_results) const
 
size_t FindHighlights (HighlightSearchOptionsKit const &in_options, HighlightSearchResults &out_results) const
 
size_t FindHighlights (KeyPath const &in_key_path, HPS::HighlightSearch::Scope in_scope, HighlightSearchOptionsKit const &in_options, HighlightSearchResults &out_results) const
 
DebuggingControl GetDebuggingControl ()
 
DebuggingControl const GetDebuggingControl () const
 
EventDispatcherGetEventDispatcher ()
 
EventDispatcher const & GetEventDispatcher () const
 
HighlightControl GetHighlightControl ()
 
HighlightControl const GetHighlightControl () const
 
PostProcessEffectsControl GetPostProcessEffectsControl ()
 
PostProcessEffectsControl const GetPostProcessEffectsControl () const
 
SelectionControl GetSelectionControl ()
 
SelectionControl const GetSelectionControl () const
 
SelectionOptionsControl GetSelectionOptionsControl ()
 
SelectionOptionsControl const GetSelectionOptionsControl () const
 
UpdateOptionsControl GetUpdateOptionsControl ()
 
UpdateOptionsControl const GetUpdateOptionsControl () const
 
WindowInfoControl const GetWindowInfoControl () const
 
HPS::Type ObjectType () const
 
WindowKeyoperator= (WindowKey const &other)
 
WindowKeyoperator= (WindowKey &&in_that)
 
WindowKeySetDebugging (DebuggingKit const &in_kit)
 
WindowKeySetDriverEventHandler (DriverEventHandler const &in_handler, intptr_t in_type)
 
WindowKeySetPostProcessEffects (PostProcessEffectsKit const &in_kit)
 
WindowKeySetSelectionOptions (SelectionOptionsKit const &in_kit)
 
WindowKeySetUpdateOptions (HPS::UpdateOptionsKit const &in_kit)
 
bool ShowDebugging (DebuggingKit &out_kit) const
 
bool ShowPostProcessEffects (PostProcessEffectsKit &out_kit) const
 
bool ShowSelectionOptions (SelectionOptionsKit &out_kit) const
 
bool ShowSnapshot (ImageKit &out_kit) const
 
bool ShowUpdateOptions (HPS::UpdateOptionsKit &out_kit) const
 
bool ShowWindowInfo (WindowInfoKit &out_kit) const
 
WindowKeyUnsetDriverEventHandler (intptr_t in_type)
 
void Update ()
 
void Update (UpdateOptionsKit const &in_kit)
 
void Update (Window::UpdateType in_type, Time in_time_limit=-1)
 
UpdateNotifier UpdateWithNotifier ()
 
UpdateNotifier UpdateWithNotifier (HPS::UpdateOptionsKit const &in_kit)
 
UpdateNotifier UpdateWithNotifier (Window::UpdateType in_type, Time in_time_limit=-1)
 
 WindowKey ()
 
 WindowKey (WindowKey const &in_window)
 
 WindowKey (WindowKey &&in_that)
 
 WindowKey (Key const &in_key)
 
 ~WindowKey ()
 
- Public Member Functions inherited from HPS::SegmentKey
SegmentKey Down (char const *in_segment_name, bool in_create_if_not_present=false) const
 
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
 
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)
 
AttributeLockControl GetAttributeLockControl ()
 
AttributeLockControl const GetAttributeLockControl () const
 
BoundingControl GetBoundingControl ()
 
BoundingControl const GetBoundingControl () const
 
CameraControl GetCameraControl ()
 
CameraControl const GetCameraControl () const
 
ColorInterpolationControl GetColorInterpolationControl ()
 
ColorInterpolationControl const GetColorInterpolationControl () const
 
ConditionControl GetConditionControl ()
 
ConditionControl const GetConditionControl () const
 
ContourLineControl GetContourLineControl ()
 
ContourLineControl const GetContourLineControl () const
 
CullingControl GetCullingControl ()
 
CullingControl const GetCullingControl () const
 
CurveAttributeControl GetCurveAttributeControl ()
 
CurveAttributeControl const GetCurveAttributeControl () const
 
CuttingSectionAttributeControl GetCuttingSectionAttributeControl ()
 
CuttingSectionAttributeControl const GetCuttingSectionAttributeControl () const
 
CylinderAttributeControl GetCylinderAttributeControl ()
 
CylinderAttributeControl const GetCylinderAttributeControl () const
 
DrawingAttributeControl GetDrawingAttributeControl ()
 
DrawingAttributeControl const GetDrawingAttributeControl () const
 
EdgeAttributeControl GetEdgeAttributeControl ()
 
EdgeAttributeControl const GetEdgeAttributeControl () const
 
HiddenLineAttributeControl GetHiddenLineAttributeControl ()
 
HiddenLineAttributeControl const GetHiddenLineAttributeControl () const
 
LightingAttributeControl GetLightingAttributeControl ()
 
LightingAttributeControl const GetLightingAttributeControl () const
 
LineAttributeControl GetLineAttributeControl ()
 
LineAttributeControl const GetLineAttributeControl () const
 
MarkerAttributeControl GetMarkerAttributeControl ()
 
MarkerAttributeControl const GetMarkerAttributeControl () const
 
MaterialMappingControl GetMaterialMappingControl ()
 
MaterialMappingControl const GetMaterialMappingControl () const
 
ModellingMatrixControl GetModellingMatrixControl ()
 
ModellingMatrixControl const GetModellingMatrixControl () const
 
NURBSSurfaceAttributeControl GetNURBSSurfaceAttributeControl ()
 
NURBSSurfaceAttributeControl const GetNURBSSurfaceAttributeControl () const
 
PerformanceControl GetPerformanceControl ()
 
PerformanceControl const GetPerformanceControl () const
 
PortfolioControl GetPortfolioControl ()
 
PortfolioControl const GetPortfolioControl () const
 
SelectabilityControl GetSelectabilityControl ()
 
SelectabilityControl const GetSelectabilityControl () const
 
SphereAttributeControl GetSphereAttributeControl ()
 
SphereAttributeControl const GetSphereAttributeControl () const
 
StyleControl GetStyleControl ()
 
StyleControl const GetStyleControl () const
 
SubwindowControl GetSubwindowControl ()
 
SubwindowControl const GetSubwindowControl () const
 
TextAttributeControl GetTextAttributeControl ()
 
TextAttributeControl const GetTextAttributeControl () const
 
TextureMatrixControl GetTextureMatrixControl ()
 
TextureMatrixControl const GetTextureMatrixControl () const
 
TransformMaskControl GetTransformMaskControl ()
 
TransformMaskControl const GetTransformMaskControl () const
 
TransparencyControl GetTransparencyControl ()
 
TransparencyControl const GetTransparencyControl () const
 
VisibilityControl GetVisibilityControl ()
 
VisibilityControl const GetVisibilityControl () const
 
VisualEffectsControl GetVisualEffectsControl ()
 
VisualEffectsControl const GetVisualEffectsControl () const
 
IncludeKey IncludeSegment (SegmentKey const &in_seg)
 
IncludeKey IncludeSegment (SegmentKey const &in_seg, ConditionalExpression const &in_conditional)
 
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)
 
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 [])
 
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)
 
DistantLightKey InsertDistantLight (Vector const &in_direction)
 
DistantLightKey InsertDistantLight (DistantLightKit const &in_kit)
 
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 in_start, float in_end)
 
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)
 
InfiniteLineKey InsertInfiniteLine (InfiniteLineKit const &in_kit)
 
InfiniteLineKey InsertInfiniteLine (Point const &in_first, Point const &in_second, InfiniteLine::Type in_type)
 
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)
 
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)
 
MarkerKey InsertMarker (Point const &in_position)
 
MarkerKey InsertMarker (MarkerKit const &in_kit)
 
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 [])
 
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[])
 
PolygonKey InsertPolygon (PolygonKit const &in_kit)
 
PolygonKey InsertPolygon (PointArray const &in_points)
 
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 [])
 
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 (EllipseKey const &in_ellipse)
 
ShellKey InsertShellFromGeometry (CircleKey const &in_circle)
 
ShellKey InsertShellFromGeometry (CircularWedgeKey const &in_circular_wedge)
 
ShellKey InsertShellFromGeometry (TextKey const &in_text)
 
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))
 
SpotlightKey InsertSpotlight (Point const &in_position, Point const &in_target)
 
SpotlightKey InsertSpotlight (SpotlightKit const &in_kit)
 
TextKey InsertText (TextKit const &in_kit)
 
TextKey InsertText (Point const &in_position, char const *in_text)
 
UTF8 Name () const
 
SegmentKeyoperator= (SegmentKey const &other)
 
SegmentKeyoperator= (SegmentKey &&in_that)
 
void Optimize (SegmentOptimizationOptionsKit const &in_kit)
 
OptimizeMappingResults OptimizeWithMapping (SegmentOptimizationOptionsKit const &in_kit)
 
ReferenceKey ReferenceGeometry (Key const &in_key)
 
ReferenceKey ReferenceGeometry (Key const &in_key, ConditionalExpression const &in_conditional)
 
 SegmentKey ()
 
 SegmentKey (SegmentKey const &in_that)
 
 SegmentKey (SegmentKey &&in_that)
 
 SegmentKey (Key const &in_that)
 
SegmentKeySetAttributeLock (AttributeLockKit const &in_kit)
 
SegmentKeySetBounding (BoundingKit const &in_kit)
 
SegmentKeySetCamera (CameraKit const &in_kit)
 
SegmentKeySetColorInterpolation (ColorInterpolationKit const &in_kit)
 
SegmentKeySetCondition (char const *in_condition)
 
SegmentKeySetConditions (UTF8Array const &in_conditions)
 
SegmentKeySetConditions (size_t in_count, UTF8 const in_conditions [])
 
SegmentKeySetContourLine (ContourLineKit const &in_kit)
 
SegmentKeySetCulling (CullingKit const &in_kit)
 
SegmentKeySetCurveAttribute (CurveAttributeKit const &in_kit)
 
SegmentKeySetCuttingSectionAttribute (CuttingSectionAttributeKit const &in_kit)
 
SegmentKeySetCylinderAttribute (CylinderAttributeKit const &in_kit)
 
SegmentKeySetDrawingAttribute (DrawingAttributeKit const &in_kit)
 
SegmentKeySetEdgeAttribute (EdgeAttributeKit const &in_kit)
 
SegmentKeySetHiddenLineAttribute (HiddenLineAttributeKit const &in_kit)
 
SegmentKeySetLightingAttribute (LightingAttributeKit const &in_kit)
 
SegmentKeySetLineAttribute (LineAttributeKit const &in_kit)
 
SegmentKeySetMarkerAttribute (MarkerAttributeKit const &in_kit)
 
SegmentKeySetMaterialMapping (MaterialMappingKit const &in_kit)
 
SegmentKeySetMaterialPalette (char const *in_name)
 
SegmentKeySetModellingMatrix (MatrixKit const &in_kit)
 
SegmentKeySetName (char const *in_name)
 
SegmentKeySetNURBSSurfaceAttribute (NURBSSurfaceAttributeKit const &in_kit)
 
SegmentKeySetPBRMaterial (PBRMaterialKit const &in_kit)
 
SegmentKeySetPerformance (PerformanceKit const &in_kit)
 
SegmentKeySetPriority (int in_priority)
 
SegmentKeySetSelectability (SelectabilityKit const &in_kit)
 
SegmentKeySetSphereAttribute (SphereAttributeKit const &in_kit)
 
SegmentKeySetSubwindow (SubwindowKit const &in_kit)
 
SegmentKeySetTextAttribute (TextAttributeKit const &in_kit)
 
SegmentKeySetTextureMatrix (MatrixKit const &in_kit)
 
SegmentKeySetTransformMask (TransformMaskKit const &in_kit)
 
SegmentKeySetTransparency (TransparencyKit const &in_kit)
 
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)
 
SegmentKeySetVisibility (VisibilityKit const &in_kit)
 
SegmentKeySetVisualEffects (VisualEffectsKit const &in_kit)
 
bool ShowAttributeLock (AttributeLockKit &out_kit) const
 
bool ShowBounding (BoundingKit &out_kit) const
 
bool ShowCamera (CameraKit &out_kit) const
 
bool ShowColorInterpolation (ColorInterpolationKit &out_kit) const
 
bool ShowConditions (UTF8Array &out_conditions) const
 
bool ShowContourLine (ContourLineKit &out_kit) const
 
bool ShowCulling (CullingKit &out_kit) const
 
bool ShowCurveAttribute (CurveAttributeKit &out_kit) const
 
bool ShowCuttingSectionAttribute (CuttingSectionAttributeKit &out_kit) const
 
bool ShowCylinderAttribute (CylinderAttributeKit &out_kit) const
 
bool ShowDrawingAttribute (DrawingAttributeKit &out_kit) const
 
bool ShowEdgeAttribute (EdgeAttributeKit &out_kit) const
 
bool ShowHiddenLineAttribute (HiddenLineAttributeKit &out_kit) const
 
size_t ShowIncluders (SegmentKeyArray &out_segments) const
 
size_t ShowIncluders (IncludeKeyArray &out_includes) const
 
bool ShowLightingAttribute (LightingAttributeKit &out_kit) const
 
bool ShowLineAttribute (LineAttributeKit &out_kit) const
 
bool ShowMarkerAttribute (MarkerAttributeKit &out_kit) const
 
bool ShowMaterialMapping (MaterialMappingKit &out_kit) const
 
bool ShowMaterialPalette (UTF8 &out_name) const
 
bool ShowModellingMatrix (MatrixKit &out_kit) const
 
bool ShowNURBSSurfaceAttribute (NURBSSurfaceAttributeKit &out_kit) const
 
bool ShowPBRMaterial (PBRMaterialKit &out_kit) const
 
bool ShowPerformance (PerformanceKit &out_kit) const
 
bool ShowPriority (int &out_priority) const
 
size_t ShowReferrers (SegmentKeyArray &out_segments) const
 
size_t ShowReferrers (ReferenceKeyArray &out_references) const
 
bool ShowSelectability (SelectabilityKit &out_kit) const
 
bool ShowSphereAttribute (SphereAttributeKit &out_kit) const
 
size_t ShowStylers (SegmentKeyArray &out_segments) const
 
size_t ShowStylers (StyleKeyArray &out_styles) const
 
size_t ShowSubsegments () const
 
size_t ShowSubsegments (SegmentKeyArray &out_children) const
 
bool ShowSubwindow (SubwindowKit &out_kit) const
 
bool ShowTextAttribute (TextAttributeKit &out_kit) const
 
bool ShowTextureMatrix (MatrixKit &out_kit) const
 
bool ShowTransformMask (TransformMaskKit &out_kit) const
 
bool ShowTransparency (TransparencyKit &out_kit) const
 
bool ShowUserData (IntPtrTArray &out_indices, ByteArrayArray &out_data) const
 
bool ShowUserData (intptr_t in_index, ByteArray &out_data) const
 
size_t ShowUserDataCount () const
 
bool ShowUserDataIndices (IntPtrTArray &out_indices) const
 
bool ShowVisibility (VisibilityKit &out_kit) const
 
bool ShowVisualEffects (VisualEffectsKit &out_kit) const
 
SegmentKey Subsegment (char const *in_segment_name="", bool in_create_if_not_present=true) const
 
SegmentKeyUnsetAllUserData ()
 
SegmentKeyUnsetAttributeLock ()
 
SegmentKeyUnsetBounding ()
 
SegmentKeyUnsetCamera ()
 
SegmentKeyUnsetColorInterpolation ()
 
SegmentKeyUnsetConditions ()
 
SegmentKeyUnsetContourLine ()
 
SegmentKeyUnsetCulling ()
 
SegmentKeyUnsetCurveAttribute ()
 
SegmentKeyUnsetCuttingSectionAttribute ()
 
SegmentKeyUnsetCylinderAttribute ()
 
SegmentKeyUnsetDrawingAttribute ()
 
SegmentKeyUnsetEdgeAttribute ()
 
SegmentKeyUnsetHiddenLineAttribute ()
 
SegmentKeyUnsetLightingAttribute ()
 
SegmentKeyUnsetLineAttribute ()
 
SegmentKeyUnsetMarkerAttribute ()
 
SegmentKeyUnsetMaterialMapping ()
 
SegmentKeyUnsetMaterialPalette ()
 
SegmentKeyUnsetModellingMatrix ()
 
SegmentKeyUnsetNURBSSurfaceAttribute ()
 
SegmentKeyUnsetPBRMaterial ()
 
SegmentKeyUnsetPerformance ()
 
SegmentKeyUnsetPriority ()
 
SegmentKeyUnsetSelectability ()
 
SegmentKeyUnsetSphereAttribute ()
 
SegmentKeyUnsetSubwindow ()
 
SegmentKeyUnsetTextAttribute ()
 
SegmentKeyUnsetTextureMatrix ()
 
SegmentKeyUnsetTransformMask ()
 
SegmentKeyUnsetTransparency ()
 
SegmentKeyUnsetUserData (intptr_t in_index)
 
SegmentKeyUnsetUserData (size_t in_count, intptr_t const in_indices[])
 
SegmentKeyUnsetUserData (HPS::IntPtrTArray const &in_indices)
 
SegmentKeyUnsetVisibility ()
 
SegmentKeyUnsetVisualEffects ()
 
 ~SegmentKey ()
 
- Public Member Functions inherited from HPS::Key
virtual void Assign (Key const &in_that)
 
Key CopyTo (SegmentKey const &in_destination) const
 
void Delete ()
 
bool Equals (Key const &in_that) const
 
size_t GetHash () const
 
bool HasOwner () const
 
 Key ()
 
 Key (Key const &in_that)
 
 Key (Control const &in_control)
 
 Key (Key &&in_that)
 
void MoveTo (SegmentKey const &in_new_owner)
 
bool operator!= (Key const &in_that) const
 
Keyoperator= (Key &&in_that)
 
Keyoperator= (Key const &in_that)
 
bool operator== (Key const &in_that) const
 
SegmentKey Owner () const
 
SegmentKey Up () const
 
virtual ~Key ()
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::WindowKey
 
- Static Public Attributes inherited from HPS::SegmentKey
static const HPS::Type staticType = HPS::Type::SegmentKey
 
- Static Public Attributes inherited from HPS::Key
static const HPS::Type staticType = HPS::Type::Key
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

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

Detailed Description

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

Constructor & Destructor Documentation

◆ WindowKey() [1/4]

HPS::WindowKey::WindowKey ( )

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

◆ WindowKey() [2/4]

HPS::WindowKey::WindowKey ( WindowKey const &  in_window)

Shares a reference to a database object referred to by in_window.

◆ WindowKey() [3/4]

HPS::WindowKey::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.

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

◆ WindowKey() [4/4]

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.

◆ ~WindowKey()

HPS::WindowKey::~WindowKey ( )

Releases a reference to a database object but does not destroy the database object.

Member Function Documentation

◆ ConvertCoordinate()

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.

◆ FindFonts()

size_t HPS::WindowKey::FindFonts ( FontSearchResults out_results) const

Searches the system for fonts.

Parameters
out_resultsOut parameter that contains results of the font search
Returns
The number of fonts found

◆ FindHighlights() [1/2]

size_t HPS::WindowKey::FindHighlights ( HighlightSearchOptionsKit const &  in_options,
HighlightSearchResults out_results 
) const

Searches for any highlights under this WindowKey.

Parameters
in_optionsSearch options constraining what type of highlights to look for. If this is empty, all highlights will be returned.
out_resultsThe key paths under the window that are highlighted with the given search options.
Returns
The number of highlighted key paths found.

◆ FindHighlights() [2/2]

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.

Parameters
in_key_pathThe key path to scope this highlight search by.
in_scopeDetermines how the scope is interpreted during a highlight search.
in_optionsSearch options constraining what type of highlights to look for. If this is empty, all highlights will be returned.
out_resultsThe key paths under the window that are highlighted with the given search options.
Returns
The number of highlighted key paths found.

◆ GetDebuggingControl() [1/2]

DebuggingControl HPS::WindowKey::GetDebuggingControl ( )

Returns a control that allows the user to manipulate and query details of the debugging attribute on this segment.

◆ GetDebuggingControl() [2/2]

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.

◆ GetEventDispatcher() [1/2]

EventDispatcher& HPS::WindowKey::GetEventDispatcher ( )

Returns a control that allows the user to interact with events in various ways.

◆ GetEventDispatcher() [2/2]

EventDispatcher const& HPS::WindowKey::GetEventDispatcher ( ) const

Returns a control that allows the user to interact with events in various ways.

◆ GetHighlightControl() [1/2]

HighlightControl HPS::WindowKey::GetHighlightControl ( )

Returns a control that allows the user to highlight segments or geometry in this window.

◆ GetHighlightControl() [2/2]

HighlightControl const HPS::WindowKey::GetHighlightControl ( ) const

Returns a control that allows the user to highlight segments or geometry in this window.

◆ GetPostProcessEffectsControl() [1/2]

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.

◆ GetPostProcessEffectsControl() [2/2]

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.

◆ GetSelectionControl() [1/2]

SelectionControl HPS::WindowKey::GetSelectionControl ( )

Returns a control that allows the user to perform selections in this window.

◆ GetSelectionControl() [2/2]

SelectionControl const HPS::WindowKey::GetSelectionControl ( ) const

Returns a control that allows the user to perform selections in this window.

◆ GetSelectionOptionsControl() [1/2]

SelectionOptionsControl HPS::WindowKey::GetSelectionOptionsControl ( )

Returns a control that allows the user to manipulate and query details of the selection options on this window.

◆ GetSelectionOptionsControl() [2/2]

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.

◆ GetUpdateOptionsControl() [1/2]

UpdateOptionsControl HPS::WindowKey::GetUpdateOptionsControl ( )

Returns a control that allows the user to change update options in this window.

◆ GetUpdateOptionsControl() [2/2]

UpdateOptionsControl const HPS::WindowKey::GetUpdateOptionsControl ( ) const

Returns a control that allows the user to change update options in this window.

◆ GetWindowInfoControl()

WindowInfoControl const HPS::WindowKey::GetWindowInfoControl ( ) const

Returns a control that allows the user to query various window properties, including size, aspect ratio, resolution, etc.

◆ ObjectType()

HPS::Type HPS::WindowKey::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

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

Reimplemented from HPS::SegmentKey.

Reimplemented in HPS::OffScreenWindowKey, HPS::ApplicationWindowKey, and HPS::StandAloneWindowKey.

◆ operator=() [1/2]

WindowKey& HPS::WindowKey::operator= ( WindowKey const &  other)

Copy assignment operator for WindowKey

◆ operator=() [2/2]

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

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

Parameters
in_thatAn rvalue reference to a WindowKey to take the impl from.
Returns
A reference to this WindowKey.

◆ SetDebugging()

WindowKey& HPS::WindowKey::SetDebugging ( DebuggingKit const &  in_kit)

Sets the debugging attributes designated by in_kit on this segment.

◆ SetDriverEventHandler()

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.

Parameters
in_handlerDriver event handler to be set.
in_typeType of driver event to add the handler for.

◆ SetPostProcessEffects()

WindowKey& HPS::WindowKey::SetPostProcessEffects ( PostProcessEffectsKit const &  in_kit)

Sets the post-process effects attributes designated by in_kit on this segment.

◆ SetSelectionOptions()

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.

◆ SetUpdateOptions()

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.

◆ ShowDebugging()

bool HPS::WindowKey::ShowDebugging ( DebuggingKit out_kit) const

Shows the debugging attribute settings on this segment.

Returns
False if no debugging attribute settings exist on this segment.

◆ ShowPostProcessEffects()

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.

◆ ShowSelectionOptions()

bool HPS::WindowKey::ShowSelectionOptions ( SelectionOptionsKit out_kit) const

Shows the options that will be used by default for selections performed from this window.

◆ ShowSnapshot()

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 or if the window key has framebuffer retention disabled.

Parameters
out_kitAn image kit to show the display into.
Returns
true if able to show display into ImageKit, false otherwise.

◆ ShowUpdateOptions()

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.

◆ UnsetDriverEventHandler()

WindowKey& HPS::WindowKey::UnsetDriverEventHandler ( intptr_t  in_type)

Unsets the driver event handler for the specified driver event type on this window.

Parameters
in_typeType of driver event to remove the handler for

◆ Update() [1/3]

void HPS::WindowKey::Update ( )

Performs a default update in this window, redrawing and refreshing the display.

◆ Update() [2/3]

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.

Parameters
in_kitAllows the user to control how thorough an update should be.

◆ Update() [3/3]

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:

  • Geometry deferral/omission
    • View-dependent shadows will not be drawn (view-independent shadows will be drawn.)
    • Transparent geometry will be deferred and processed after the rest of the scene.
    • If static tree + lmv is enabled, text and lines will be deferred and drawn after opaque facetted geometry
  • Non-incremental rendering modes/attributes
    • A timed update requires Visualize to interrupt the rendering process. However, certain types of rendering modes/attributes cannot be interrupted because they are 'non-incremental'. - If your application wishes to use such modes/attributes alongside fixed-framerate, it will need to make a decision about whether Fixed-framerate is preferred. They include: - HiddenLine and FastHiddenLine rendering algorithms
      • Transparency that is drawn using 'depth peeling'. (All depth-peeled transparent geometry will be processed once it is started.)
Parameters
in_controlAllows the user to control how thorough this update should be.
in_time_limitSpecifies the desired maximum time this update should take.

◆ UpdateWithNotifier() [1/3]

UpdateNotifier HPS::WindowKey::UpdateWithNotifier ( )

Performs a default update in this window, redrawing and refreshing the display.

Returns
A UpdateNotifier object that can be used to find out information about the update.

◆ UpdateWithNotifier() [2/3]

UpdateNotifier HPS::WindowKey::UpdateWithNotifier ( HPS::UpdateOptionsKit const &  in_kit)

Performs a default update in this window, redrawing and refreshing the display.

Returns
A UpdateNotifier object that can be used to find out information about the update.

◆ UpdateWithNotifier() [3/3]

UpdateNotifier HPS::WindowKey::UpdateWithNotifier ( Window::UpdateType  in_type,
Time  in_time_limit = -1 
)

Performs an update in this window, redrawing and refreshing the display.

Parameters
in_typeAllows the user to control how thorough an update should be.
in_time_limitSpecifies a maximum time this update should take.
Returns
A UpdateNotifier object that can be used to find out information about the update.

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