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);
460 UpdateNotifier UpdateWithNotifier(HPS::Window::UpdateType in_type, HPS::Time in_time_limit = -1.0) const;
554 UpdateNotifier UpdateWithNotifier(HPS::Window::UpdateType in_type, HPS::Time in_time_limit = -1.0) const;
590 void AttachViewFront(View const & in_view, HPS::Rectangle const & in_position = HPS::Rectangle(-1.0f, 1.0f, -1.0f, 1.0f));
594 void AttachViewBack(View const & in_view, HPS::Rectangle const & in_position = HPS::Rectangle(-1.0f, 1.0f, -1.0f, 1.0f));
673 UpdateNotifier UpdateWithNotifier(HPS::Window::UpdateType in_type, HPS::Time in_time_limit = -1.0) const;
833 : Event(), layout(in_layout), action(Action::AllLayers), layer(std::numeric_limits<size_t>::max()), view(in_view)
1036 CameraChangedEvent const * that_event = static_cast<CameraChangedEvent const *>(in_that_event);
1066 SprocketPath(Model const & in_model, View const & in_view, Layout const & in_layout, Canvas const & in_canvas);
1067 SprocketPath(Canvas const & in_canvas, Layout const & in_layout, View const & in_view, Model const & in_model);
1107 Operator(MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys());
1141 virtual bool OnMouseDown(MouseState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1146 virtual bool OnMouseUp(MouseState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1151 virtual bool OnMouseMove(MouseState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1156 virtual bool OnMouseWheel(MouseState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1161 virtual bool OnMouseEnter(MouseState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1166 virtual bool OnMouseLeave(MouseState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1171 virtual bool OnTouchDown(TouchState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1176 virtual bool OnTouchUp(TouchState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1181 virtual bool OnTouchMove(TouchState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1186 virtual bool OnKeyDown(KeyboardState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1191 virtual bool OnKeyUp(KeyboardState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1196 virtual bool OnTextInput(HPS::UTF8 const & in_text) { HPS_UNREFERENCED(in_text); return false; }
1201 virtual bool OnTimerTick(HPS::TimerTickEvent const & in_event) { HPS_UNREFERENCED(in_event); return false; }
1233 virtual bool IsMouseTriggered(MouseState const & in_state) { return in_state.HasAll(mouse_trigger, modifier_trigger); }
1347 OperatorControl & Push(OperatorPtr const & in_operator, Operator::Priority in_priority = Operator::Priority::Default);
1355 OperatorControl & Push(Operator * in_operator, Operator::Priority in_priority = Operator::Priority::Default);
1381 OperatorControl & Set(OperatorPtr const & in_operator, Operator::Priority in_priority = Operator::Priority::Default);
1389 OperatorControl & Set(Operator * in_operator, Operator::Priority in_priority = Operator::Priority::Default);
1396 OperatorControl & Set(OperatorPtrArray & in_operators, Operator::Priority in_priority = Operator::Priority::Default);
1404 OperatorControl & Set(size_t in_count, OperatorPtr in_operators [], Operator::Priority in_priority = Operator::Priority::Default);
1500 NavigationCubeControl & SetLocation(Location in_location, HPS::Rectangle const & in_rectangle = HPS::Rectangle(), HPS::IntRectangle in_offsets = HPS::IntRectangle::Zero());
1647 HPS::AxisTriadControl & SetLocation(Location in_location, HPS::Rectangle const & in_position = HPS::Rectangle(), HPS::IntRectangle in_offsets = HPS::IntRectangle::Zero());
2196 void Highlight(Canvas const & in_canvas, HighlightOptionsKit const & in_options, bool in_remove_existing = true) const;
2204 void Highlight(Canvas const & in_canvas, size_t in_layer, HighlightOptionsKit const & in_options, bool in_remove_existing = true) const;
2209 void Unhighlight(Canvas const & in_canvas, HighlightOptionsKit const & in_options = HighlightOptionsKit()) const;
2215 void Unhighlight(Canvas const & in_canvas, size_t in_layer, HighlightOptionsKit const & in_options = HighlightOptionsKit()) const;
2228 void Show(Canvas const & in_canvas, size_t in_layer = 0, Component::Visibility in_subtree_visibility = Component::Visibility::PreserveNone);
2243 void Isolate(Canvas const & in_canvas, size_t in_layer = 0, Component::Visibility in_subtree_visibility = Component::Visibility::PreserveNone);
2252 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);
2509 FilterActivationEvent(Filter in_filter, Action in_action, View in_view) : Event(), filter(in_filter), action(in_action), view(in_view)
2598 CaptureActivationEvent(Capture in_capture, View in_view) : Event(), capture(in_capture), view(in_view)
3130 static Canvas CreateCanvas(HPS::WindowHandle in_window_handle, char const * in_name = "", HPS::ApplicationWindowOptionsKit const & in_options = HPS::ApplicationWindowOptionsKit());
3136 static Canvas CreateCanvas(char const * in_name = "", HPS::StandAloneWindowOptionsKit const & in_options = HPS::StandAloneWindowOptionsKit());
3143 static Canvas CreateCanvas(HPS::WindowKey const & in_window_key, HPS::PortfolioKey const & in_portfolio_key = HPS::PortfolioKey(), char const * in_name = "");
3178 AxisTriadOperator(MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys());
3303 NavigationCubeOperator(MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys());
3754 SceneTreeItem(SceneTreePtr const & in_tree, Key const & in_key, SceneTree::ItemType in_type, char const * in_title = nullptr);
3830 virtual SceneTreeItemPtr AddChild(Key const & in_key, SceneTree::ItemType in_type, char const * in_title = nullptr) = 0;
4108 ComponentTreeItem(ComponentTreePtr const & in_tree, Component const & in_component, ComponentTree::ItemType in_type);
4179 virtual ComponentTreeItemPtr AddChild(Component const & in_component, ComponentTree::ItemType in_type) = 0;
4281 void Isolate(Component::Visibility in_subtree_visibility = Component::Visibility::PreserveNone);
Definition: sprk.h:2996
Definition: hps.h:3390
Definition: hps.h:6208
Definition: sprk.h:1002
Definition: sprk.h:3175
Definition: sprk.h:267
ComponentHighlightEvent(Event const &in_event)
Definition: sprk.h:2417
virtual bool OnTimerTick(HPS::TimerTickEvent const &in_event)
Definition: sprk.h:1201
Definition: hps.h:42280
ComponentHighlightEvent()
Definition: sprk.h:2399
void SetModifierTrigger(ModifierKeys in_modifiers)
Definition: sprk.h:1227
Definition: hps.h:470
CameraChangedEvent(Event const &in_event)
Definition: sprk.h:1021
virtual bool OnKeyDown(KeyboardState const &in_state)
Definition: sprk.h:1186
An InvalidSpecificationException is thrown when a method is called with non-sensical or contradictory...
Definition: hps.h:5823
Definition: hps.h:5863
Definition: sprk.h:66
Definition: sprk.h:208
ComponentIsolateEvent(Event const &in_event)
Definition: sprk.h:2360
Definition: sprk.h:677
Definition: sprk.h:100
virtual bool OnMouseMove(MouseState const &in_state)
Definition: sprk.h:1151
Definition: sprk.h:4081
virtual bool OnMouseEnter(MouseState const &in_state)
Definition: sprk.h:1161
Definition: sprk.h:3050
Definition: hps.h:42063
Definition: hps.h:1056
Definition: hps.h:1732
Definition: sprk.h:236
SmoothTransitionCompleteEvent(HPS::View const &in_view)
Definition: sprk.h:3246
std::vector< KeyPath, Allocator< KeyPath > > KeyPathArray
Array of type HPS::KeyPath.
Definition: hps.h:6674
Definition: sprk.h:3921
Definition: hps.h:47626
Definition: sprk.h:1062
Definition: hps.h:7714
Definition: hps.h:3541
Definition: hps.h:2098
Definition: sprk.h:914
bool HasAll(MouseButtons in_mouse_trigger, ModifierKeys in_modifier_trigger) const
Definition: sprk.h:2338
Definition: sprk.h:765
Definition: hps.h:1421
Definition: hps.h:877
Definition: hps.h:42183
SmoothTransitionCompleteEvent(Event const &in_event)
Definition: sprk.h:3251
Definition: hps.h:1790
Definition: hps.h:1556
Definition: hps.h:8941
Definition: hps.h:244
ComponentPath & Append(Component const &in_component)
Definition: hps.h:1850
Definition: hps.h:47524
Definition: hps.h:41116
Definition: sprk.h:959
Definition: sprk.h:561
ViewDetachedEvent(Event const &in_event)
Definition: sprk.h:841
Definition: hps.h:41163
Definition: hps.h:40548
Definition: hps.h:43779
Definition: hps.h:1096
Definition: sprk.h:2735
Definition: sprk.h:2849
virtual bool OnMouseLeave(MouseState const &in_state)
Definition: sprk.h:1166
Definition: hps.h:9772
Definition: hps.h:42227
Definition: hps.h:1509
SmoothTransitionCompleteEvent()
Definition: sprk.h:3241
Definition: hps.h:1441
Definition: hps.h:1460
Definition: hps.h:38298
FilterActivationEvent(Event const &in_event)
Definition: sprk.h:2517
ModelDetachedEvent(Event const &in_event)
Definition: sprk.h:933
Definition: hps.h:7085
Definition: hps.h:46995
Definition: sprk.h:2800
Definition: sprk.h:1601
Definition: hps.h:43958
SprocketControl & operator=(SprocketControl &&in_that)
Definition: sprk.h:229
Definition: hps.h:45890
Definition: hps.h:47411
Definition: sprk.h:720
CaptureActivationEvent(Event const &in_event)
Definition: sprk.h:2606
virtual bool OnTouchDown(TouchState const &in_state)
Definition: sprk.h:1171
virtual bool OnMouseWheel(MouseState const &in_state)
Definition: sprk.h:1156
SprocketControl(SprocketControl &&in_that)
Definition: sprk.h:224
Definition: hps.h:15474
Definition: sprk.h:808
virtual bool Drop(Event const *in_that_event) const
Definition: sprk.h:3273
Definition: sprk.h:1739
Definition: hps.h:44237
Definition: hps.h:46502
ViewDeletedEvent(Event const &in_event)
Definition: sprk.h:890
Definition: hps.h:37859
Definition: sprk.h:2947
Definition: hps.h:6292
Override the visibility for any components in the subtree under the ComponentPath specified regardles...
Definition: sprk.h:1305
Definition: hps.h:406
Definition: sprk.h:481
CanvasDeletedEvent(Event const &in_event)
Definition: sprk.h:696
Definition: sprk.h:2065
virtual bool Drop(Event const *in_that_event) const
Definition: sprk.h:1034
Definition: hps.h:45815
std::vector< Key, Allocator< Key > > KeyArray
Array of type HPS::Key.
Definition: hps.h:6646
Definition: hps.h:2117
Definition: sprk.h:2388
LayoutDetachedEvent(Event const &in_event)
Definition: sprk.h:739
virtual bool OnMouseDown(MouseState const &in_state)
Definition: sprk.h:1141
Definition: sprk.h:2447
Definition: sprk.h:3101
Definition: sprk.h:185
Definition: sprk.h:3237
Definition: hps.h:425
Definition: sprk.h:2547
Definition: hps.h:2137
Definition: sprk.h:3424
Definition: sprk.h:2898
Definition: hps.h:9099
virtual bool IsMouseTriggered(MouseState const &in_state)
Definition: sprk.h:1233
Definition: hps.h:7632
Definition: sprk.h:2492
Definition: hps.h:37472
Definition: hps.h:351
ModelDeletedEvent(Event const &in_event)
Definition: sprk.h:978
LayoutDeletedEvent(Event const &in_event)
Definition: sprk.h:784
Definition: hps.h:9328
Definition: hps.h:10877
Definition: sprk.h:1248
virtual bool OnTouchMove(TouchState const &in_state)
Definition: sprk.h:1181
Definition: sprk.h:3705
Definition: sprk.h:2634
Definition: hps.h:42759
Definition: hps.h:511
Definition: sprk.h:1104
Definition: hps.h:1139
Definition: hps.h:42109
Definition: sprk.h:871
Definition: sprk.h:2588
Definition: hps.h:40612
Definition: hps.h:7343