sprk.h
18 # pragma warning(disable: 4251) //Not an issue as long as debug and release libraries aren't mixed
94 typedef std::vector<HighlightOptionsKit, Allocator<HighlightOptionsKit>> HighlightOptionsKitArray;
172 UpdateNotifier UpdateWithNotifier(HPS::Window::UpdateType in_type, HPS::Time in_time_limit = -1.0) const;
305 HPS::View & ComputeFitWorldCamera(BoundingKit const & in_bounding, HPS::CameraKit & out_camera);
312 HPS::View & ComputeFitWorldCamera(SegmentKey const & in_segment, MatrixKit const & in_transform, HPS::CameraKit & out_camera);
320 HPS::View & ComputeFitWorldCamera(BoundingKit const & in_bounding, MatrixKit const & in_transform, HPS::CameraKit & out_camera);
456 UpdateNotifier UpdateWithNotifier(HPS::Window::UpdateType in_type, HPS::Time in_time_limit = -1.0) const;
550 UpdateNotifier UpdateWithNotifier(HPS::Window::UpdateType in_type, HPS::Time in_time_limit = -1.0) const;
586 void AttachViewFront(View const & in_view, HPS::Rectangle const & in_position = HPS::Rectangle(-1.0f, 1.0f, -1.0f, 1.0f));
590 void AttachViewBack(View const & in_view, HPS::Rectangle const & in_position = HPS::Rectangle(-1.0f, 1.0f, -1.0f, 1.0f));
669 UpdateNotifier UpdateWithNotifier(HPS::Window::UpdateType in_type, HPS::Time in_time_limit = -1.0) const;
829 : Event(), layout(in_layout), action(Action::AllLayers), layer(std::numeric_limits<size_t>::max()), view(in_view)
1032 CameraChangedEvent const * that_event = static_cast<CameraChangedEvent const *>(in_that_event);
1062 SprocketPath(Model const & in_model, View const & in_view, Layout const & in_layout, Canvas const & in_canvas);
1063 SprocketPath(Canvas const & in_canvas, Layout const & in_layout, View const & in_view, Model const & in_model);
1103 Operator(MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys());
1137 virtual bool OnMouseDown(MouseState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1142 virtual bool OnMouseUp(MouseState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1147 virtual bool OnMouseMove(MouseState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1152 virtual bool OnMouseWheel(MouseState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1157 virtual bool OnMouseEnter(MouseState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1162 virtual bool OnMouseLeave(MouseState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1167 virtual bool OnTouchDown(TouchState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1172 virtual bool OnTouchUp(TouchState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1177 virtual bool OnTouchMove(TouchState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1182 virtual bool OnKeyDown(KeyboardState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1187 virtual bool OnKeyUp(KeyboardState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1192 virtual bool OnTextInput(HPS::UTF8 const & in_text) { HPS_UNREFERENCED(in_text); return false; }
1197 virtual bool OnTimerTick(HPS::TimerTickEvent const & in_event) { HPS_UNREFERENCED(in_event); return false; }
1229 virtual bool IsMouseTriggered(MouseState const & in_state) { return in_state.HasAll(mouse_trigger, modifier_trigger); }
1343 OperatorControl & Push(OperatorPtr const & in_operator, Operator::Priority in_priority = Operator::Priority::Default);
1351 OperatorControl & Push(Operator * in_operator, Operator::Priority in_priority = Operator::Priority::Default);
1377 OperatorControl & Set(OperatorPtr const & in_operator, Operator::Priority in_priority = Operator::Priority::Default);
1385 OperatorControl & Set(Operator * in_operator, Operator::Priority in_priority = Operator::Priority::Default);
1392 OperatorControl & Set(OperatorPtrArray & in_operators, Operator::Priority in_priority = Operator::Priority::Default);
1400 OperatorControl & Set(size_t in_count, OperatorPtr in_operators [], Operator::Priority in_priority = Operator::Priority::Default);
1496 NavigationCubeControl & SetLocation(Location in_location, HPS::Rectangle const & in_rectangle = HPS::Rectangle(), HPS::IntRectangle in_offsets = HPS::IntRectangle::Zero());
1643 HPS::AxisTriadControl & SetLocation(Location in_location, HPS::Rectangle const & in_position = HPS::Rectangle(), HPS::IntRectangle in_offsets = HPS::IntRectangle::Zero());
2192 void Highlight(Canvas const & in_canvas, HighlightOptionsKit const & in_options, bool in_remove_existing = true) const;
2200 void Highlight(Canvas const & in_canvas, size_t in_layer, HighlightOptionsKit const & in_options, bool in_remove_existing = true) const;
2205 void Unhighlight(Canvas const & in_canvas, HighlightOptionsKit const & in_options = HighlightOptionsKit()) const;
2211 void Unhighlight(Canvas const & in_canvas, size_t in_layer, HighlightOptionsKit const & in_options = HighlightOptionsKit()) const;
2224 void Show(Canvas const & in_canvas, size_t in_layer = 0, Component::Visibility in_subtree_visibility = Component::Visibility::PreserveNone);
2239 void Isolate(Canvas const & in_canvas, size_t in_layer = 0, Component::Visibility in_subtree_visibility = Component::Visibility::PreserveNone);
2248 static void Isolate(HPS::ComponentPathArray & in_components_to_be_isolated, Canvas const & in_canvas, size_t in_layer = 0, Component::Visibility in_subtree_visibility = Component::Visibility::PreserveNone);
2505 FilterActivationEvent(Filter in_filter, Action in_action, View in_view) : Event(), filter(in_filter), action(in_action), view(in_view)
2594 CaptureActivationEvent(Capture in_capture, View in_view) : Event(), capture(in_capture), view(in_view)
3126 static Canvas CreateCanvas(HPS::WindowHandle in_window_handle, char const * in_name = "", HPS::ApplicationWindowOptionsKit const & in_options = HPS::ApplicationWindowOptionsKit());
3132 static Canvas CreateCanvas(char const * in_name = "", HPS::StandAloneWindowOptionsKit const & in_options = HPS::StandAloneWindowOptionsKit());
3139 static Canvas CreateCanvas(HPS::WindowKey const & in_window_key, HPS::PortfolioKey const & in_portfolio_key = HPS::PortfolioKey(), char const * in_name = "");
3174 AxisTriadOperator(MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys());
3299 NavigationCubeOperator(MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys());
3749 SceneTreeItem(SceneTreePtr const & in_tree, Key const & in_key, SceneTree::ItemType in_type, char const * in_title = nullptr);
3825 virtual SceneTreeItemPtr AddChild(Key const & in_key, SceneTree::ItemType in_type, char const * in_title = nullptr) = 0;
4103 ComponentTreeItem(ComponentTreePtr const & in_tree, Component const & in_component, ComponentTree::ItemType in_type);
4174 virtual ComponentTreeItemPtr AddChild(Component const & in_component, ComponentTree::ItemType in_type) = 0;
4276 void Isolate(Component::Visibility in_subtree_visibility = Component::Visibility::PreserveNone);
Definition: sprk.h:2992
Definition: hps.h:3383
Definition: hps.h:6201
Definition: sprk.h:998
Definition: sprk.h:3171
Definition: sprk.h:267
ComponentHighlightEvent(Event const &in_event)
Definition: sprk.h:2413
virtual bool OnTimerTick(HPS::TimerTickEvent const &in_event)
Definition: sprk.h:1197
Definition: hps.h:42217
ComponentHighlightEvent()
Definition: sprk.h:2395
void SetModifierTrigger(ModifierKeys in_modifiers)
Definition: sprk.h:1223
Definition: hps.h:470
CameraChangedEvent(Event const &in_event)
Definition: sprk.h:1017
virtual bool OnKeyDown(KeyboardState const &in_state)
Definition: sprk.h:1182
An InvalidSpecificationException is thrown when a method is called with non-sensical or contradictory...
Definition: hps.h:5816
Definition: hps.h:5856
Definition: sprk.h:66
Definition: sprk.h:208
ComponentIsolateEvent(Event const &in_event)
Definition: sprk.h:2356
Definition: sprk.h:673
Definition: sprk.h:100
virtual bool OnMouseMove(MouseState const &in_state)
Definition: sprk.h:1147
Definition: sprk.h:4076
virtual bool OnMouseEnter(MouseState const &in_state)
Definition: sprk.h:1157
Definition: sprk.h:3046
Definition: hps.h:42000
Definition: hps.h:1055
Definition: hps.h:1725
Definition: sprk.h:236
SmoothTransitionCompleteEvent(HPS::View const &in_view)
Definition: sprk.h:3242
std::vector< KeyPath, Allocator< KeyPath > > KeyPathArray
Array of type HPS::KeyPath.
Definition: hps.h:6667
Definition: sprk.h:3916
Definition: hps.h:47549
Definition: sprk.h:1058
Definition: hps.h:7707
Definition: hps.h:3534
Definition: hps.h:2091
Definition: sprk.h:910
bool HasAll(MouseButtons in_mouse_trigger, ModifierKeys in_modifier_trigger) const
Definition: sprk.h:2334
Definition: sprk.h:761
Definition: hps.h:1420
Definition: hps.h:876
Definition: hps.h:42120
SmoothTransitionCompleteEvent(Event const &in_event)
Definition: sprk.h:3247
Definition: hps.h:1783
Definition: hps.h:1549
Definition: hps.h:8934
Definition: hps.h:244
ComponentPath & Append(Component const &in_component)
Definition: hps.h:1843
Definition: hps.h:47447
Definition: hps.h:41053
Definition: sprk.h:955
Definition: sprk.h:557
ViewDetachedEvent(Event const &in_event)
Definition: sprk.h:837
Definition: hps.h:41100
Definition: hps.h:40485
Definition: hps.h:43702
Definition: hps.h:1095
Definition: sprk.h:2731
Definition: sprk.h:2845
virtual bool OnMouseLeave(MouseState const &in_state)
Definition: sprk.h:1162
Definition: hps.h:9765
Definition: hps.h:42164
Definition: hps.h:1508
SmoothTransitionCompleteEvent()
Definition: sprk.h:3237
Definition: hps.h:1440
Definition: hps.h:1459
Definition: hps.h:38235
FilterActivationEvent(Event const &in_event)
Definition: sprk.h:2513
ModelDetachedEvent(Event const &in_event)
Definition: sprk.h:929
Definition: hps.h:7078
Definition: hps.h:46918
Definition: sprk.h:2796
Definition: sprk.h:1597
Definition: hps.h:43881
SprocketControl & operator=(SprocketControl &&in_that)
Definition: sprk.h:229
Definition: hps.h:45813
Definition: hps.h:47334
Definition: sprk.h:716
CaptureActivationEvent(Event const &in_event)
Definition: sprk.h:2602
virtual bool OnTouchDown(TouchState const &in_state)
Definition: sprk.h:1167
virtual bool OnMouseWheel(MouseState const &in_state)
Definition: sprk.h:1152
SprocketControl(SprocketControl &&in_that)
Definition: sprk.h:224
Definition: hps.h:15442
Definition: sprk.h:804
virtual bool Drop(Event const *in_that_event) const
Definition: sprk.h:3269
Definition: sprk.h:1735
Definition: hps.h:44160
Definition: hps.h:46425
ViewDeletedEvent(Event const &in_event)
Definition: sprk.h:886
Definition: hps.h:37796
Definition: sprk.h:2943
Definition: hps.h:6285
Override the visibility for any components in the subtree under the ComponentPath specified regardles...
Definition: sprk.h:1301
Definition: hps.h:406
Definition: sprk.h:477
CanvasDeletedEvent(Event const &in_event)
Definition: sprk.h:692
Definition: sprk.h:2061
virtual bool Drop(Event const *in_that_event) const
Definition: sprk.h:1030
Definition: hps.h:45738
std::vector< Key, Allocator< Key > > KeyArray
Array of type HPS::Key.
Definition: hps.h:6639
Definition: hps.h:2110
Definition: sprk.h:2384
LayoutDetachedEvent(Event const &in_event)
Definition: sprk.h:735
virtual bool OnMouseDown(MouseState const &in_state)
Definition: sprk.h:1137
Definition: sprk.h:2443
Definition: sprk.h:3097
Definition: sprk.h:185
Definition: sprk.h:3233
Definition: hps.h:425
Definition: sprk.h:2543
Definition: hps.h:2130
Definition: sprk.h:3420
Definition: sprk.h:2894
Definition: hps.h:9092
virtual bool IsMouseTriggered(MouseState const &in_state)
Definition: sprk.h:1229
Definition: hps.h:7625
Definition: sprk.h:2488
Definition: hps.h:37409
Definition: hps.h:351
ModelDeletedEvent(Event const &in_event)
Definition: sprk.h:974
LayoutDeletedEvent(Event const &in_event)
Definition: sprk.h:780
Definition: hps.h:9321
Definition: hps.h:10870
Definition: sprk.h:1244
virtual bool OnTouchMove(TouchState const &in_state)
Definition: sprk.h:1177
Definition: sprk.h:3700
Definition: sprk.h:2630
Definition: hps.h:42696
Definition: hps.h:511
Definition: sprk.h:1100
Definition: hps.h:1138
Definition: hps.h:42046
Definition: sprk.h:867
Definition: sprk.h:2584
Definition: hps.h:40549
Definition: hps.h:7336