sprk.h
18 # pragma warning(disable: 4251) //Not an issue as long as debug and release libraries aren't mixed
99 typedef std::vector<HighlightOptionsKit, Allocator<HighlightOptionsKit>> HighlightOptionsKitArray;
177 UpdateNotifier UpdateWithNotifier(HPS::Window::UpdateType in_type, HPS::Time in_time_limit = -1.0) const;
310 HPS::View & ComputeFitWorldCamera(BoundingKit const & in_bounding, HPS::CameraKit & out_camera);
317 HPS::View & ComputeFitWorldCamera(SegmentKey const & in_segment, MatrixKit const & in_transform, HPS::CameraKit & out_camera);
325 HPS::View & ComputeFitWorldCamera(BoundingKit const & in_bounding, MatrixKit const & in_transform, HPS::CameraKit & out_camera);
465 UpdateNotifier UpdateWithNotifier(HPS::Window::UpdateType in_type, HPS::Time in_time_limit = -1.0) const;
559 UpdateNotifier UpdateWithNotifier(HPS::Window::UpdateType in_type, HPS::Time in_time_limit = -1.0) const;
595 void AttachViewFront(View const & in_view, HPS::Rectangle const & in_position = HPS::Rectangle(-1.0f, 1.0f, -1.0f, 1.0f));
599 void AttachViewBack(View const & in_view, HPS::Rectangle const & in_position = HPS::Rectangle(-1.0f, 1.0f, -1.0f, 1.0f));
678 UpdateNotifier UpdateWithNotifier(HPS::Window::UpdateType in_type, HPS::Time in_time_limit = -1.0) const;
838 : Event(), layout(in_layout), action(Action::AllLayers), layer(std::numeric_limits<size_t>::max()), view(in_view)
1041 CameraChangedEvent const * that_event = static_cast<CameraChangedEvent const *>(in_that_event);
1071 SprocketPath(Model const & in_model, View const & in_view, Layout const & in_layout, Canvas const & in_canvas);
1072 SprocketPath(Canvas const & in_canvas, Layout const & in_layout, View const & in_view, Model const & in_model);
1112 Operator(MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys());
1146 virtual bool OnMouseDown(MouseState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1151 virtual bool OnMouseUp(MouseState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1156 virtual bool OnMouseMove(MouseState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1161 virtual bool OnMouseWheel(MouseState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1166 virtual bool OnMouseEnter(MouseState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1171 virtual bool OnMouseLeave(MouseState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1176 virtual bool OnTouchDown(TouchState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1181 virtual bool OnTouchUp(TouchState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1186 virtual bool OnTouchMove(TouchState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1191 virtual bool OnKeyDown(KeyboardState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1196 virtual bool OnKeyUp(KeyboardState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1201 virtual bool OnTextInput(HPS::UTF8 const & in_text) { HPS_UNREFERENCED(in_text); return false; }
1206 virtual bool OnTimerTick(HPS::TimerTickEvent const & in_event) { HPS_UNREFERENCED(in_event); return false; }
1210 virtual void OnViewAttached(HPS::View const & in_attached_view) { HPS_UNREFERENCED(in_attached_view); return; }
1214 virtual void OnViewDetached(HPS::View const & in_detached_view) { HPS_UNREFERENCED(in_detached_view); return; }
1240 virtual bool IsMouseTriggered(MouseState const & in_state) { return in_state.HasAll(mouse_trigger, modifier_trigger); }
1354 OperatorControl & Push(OperatorPtr const & in_operator, Operator::Priority in_priority = Operator::Priority::Default);
1362 OperatorControl & Push(Operator * in_operator, Operator::Priority in_priority = Operator::Priority::Default);
1388 OperatorControl & Set(OperatorPtr const & in_operator, Operator::Priority in_priority = Operator::Priority::Default);
1396 OperatorControl & Set(Operator * in_operator, Operator::Priority in_priority = Operator::Priority::Default);
1403 OperatorControl & Set(OperatorPtrArray & in_operators, Operator::Priority in_priority = Operator::Priority::Default);
1411 OperatorControl & Set(size_t in_count, OperatorPtr in_operators [], Operator::Priority in_priority = Operator::Priority::Default);
1507 NavigationCubeControl & SetLocation(Location in_location, HPS::Rectangle const & in_rectangle = HPS::Rectangle(), HPS::IntRectangle in_offsets = HPS::IntRectangle::Zero());
1654 HPS::AxisTriadControl & SetLocation(Location in_location, HPS::Rectangle const & in_position = HPS::Rectangle(), HPS::IntRectangle in_offsets = HPS::IntRectangle::Zero());
2226 void Highlight(Canvas const & in_canvas, HighlightOptionsKit const & in_options, bool in_remove_existing = true) const;
2234 void Highlight(Canvas const & in_canvas, size_t in_layer, HighlightOptionsKit const & in_options, bool in_remove_existing = true) const;
2239 void Unhighlight(Canvas const & in_canvas, HighlightOptionsKit const & in_options = HighlightOptionsKit()) const;
2245 void Unhighlight(Canvas const & in_canvas, size_t in_layer, HighlightOptionsKit const & in_options = HighlightOptionsKit()) const;
2258 void Show(Canvas const & in_canvas, size_t in_layer = 0, Component::Visibility in_subtree_visibility = Component::Visibility::PreserveNone);
2273 void Isolate(Canvas const & in_canvas, size_t in_layer = 0, Component::Visibility in_subtree_visibility = Component::Visibility::PreserveNone);
2282 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);
2288 /* Access a Component in this ComponentPath object. An HPS::IndexOutOfRangeException exception is thrown if in_index is out of range.
2293 /* Access a Component in this ComponentPath object. An HPS::IndexOutOfRangeException exception is thrown if in_index is out of range.
2298 /* Inserts in_item in the ComponentPath before the element at position in_index, increasing the size of the ComponentPath by one.
2304 /* Traverses the components in this ComponentPath and removes the first one which matches in_item
2309 /* Removes the the component at position in_index from this ComponentPath. An HPS::IndexOutOfRangeException exception is thrown if in_index is out of range.
2313 /* Creates and returns a new ComponentPath object, with the components organized in the reverse order.
2317 /* Returns the first component of this ComponentPath. An HPS::IndexOutOfRangeException exception is thrown if the ComponentPath is empty.
2321 /* Returns the first component of this ComponentPath. An HPS::IndexOutOfRangeException exception is thrown if the ComponentPath is empty.
2325 /* Returns the last component of this ComponentPath. An HPS::IndexOutOfRangeException exception is thrown if the ComponentPath is empty.
2329 /* Returns the last component of this ComponentPath. An HPS::IndexOutOfRangeException exception is thrown if the ComponentPath is empty.
2333 /* Returns the first component of this ComponentPath and returns it. An HPS::IndexOutOfRangeException exception is thrown if the ComponentPath is empty.
2337 /* Returns the last component of this ComponentPath and returns it. An HPS::IndexOutOfRangeException exception is thrown if the ComponentPath is empty.
2374 * \return A constant iterator pointing to the last Component contained in this ComponentPath. */
2378 * \return A constant iterator pointing to the last Component contained in this ComponentPath. */
2382 * \return A constant iterator pointing to the first Component contained in this ComponentPath. */
2386 * \return A constant iterator pointing to the last Component contained in this ComponentPath. */
2645 FilterActivationEvent(Filter in_filter, Action in_action, View in_view) : Event(), filter(in_filter), action(in_action), view(in_view)
2734 CaptureActivationEvent(Capture in_capture, View in_view) : Event(), capture(in_capture), view(in_view)
2824 ComponentPath GetComponentPath(KeyPath const & in_key_path, ComponentPath::PathType in_path_type = ComponentPath::PathType::Unique) const;
2837 ComponentPath GetComponentPath(SelectionItem const & in_item, ComponentPath::PathType in_path_type = ComponentPath::PathType::Unique) const;
3273 static Canvas CreateCanvas(HPS::WindowHandle in_window_handle, char const * in_name = "", HPS::ApplicationWindowOptionsKit const & in_options = HPS::ApplicationWindowOptionsKit());
3279 static Canvas CreateCanvas(char const * in_name = "", HPS::StandAloneWindowOptionsKit const & in_options = HPS::StandAloneWindowOptionsKit());
3286 static Canvas CreateCanvas(HPS::WindowKey const & in_window_key, HPS::PortfolioKey const & in_portfolio_key = HPS::PortfolioKey(), char const * in_name = "");
3332 AxisTriadOperator(MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys());
3457 NavigationCubeOperator(MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys());
3919 SceneTreeItem(SceneTreePtr const & in_tree, Key const & in_key, SceneTree::ItemType in_type, char const * in_title = nullptr);
3995 virtual SceneTreeItemPtr AddChild(Key const & in_key, SceneTree::ItemType in_type, char const * in_title = nullptr) = 0;
4273 ComponentTreeItem(ComponentTreePtr const & in_tree, Component const & in_component, ComponentTree::ItemType in_type);
4344 virtual ComponentTreeItemPtr AddChild(Component const & in_component, ComponentTree::ItemType in_type) = 0;
4446 void Isolate(Component::Visibility in_subtree_visibility = Component::Visibility::PreserveNone);
Definition: sprk.h:3139
Definition: hps.h:3412
Definition: hps.h:6241
Definition: sprk.h:1007
Definition: sprk.h:3329
Definition: sprk.h:272
ComponentHighlightEvent(Event const &in_event)
Definition: sprk.h:2553
virtual bool OnTimerTick(HPS::TimerTickEvent const &in_event)
Definition: sprk.h:1206
Definition: hps.h:42726
ComponentHighlightEvent()
Definition: sprk.h:2535
void SetModifierTrigger(ModifierKeys in_modifiers)
Definition: sprk.h:1234
Definition: hps.h:470
CameraChangedEvent(Event const &in_event)
Definition: sprk.h:1026
virtual bool OnKeyDown(KeyboardState const &in_state)
Definition: sprk.h:1191
An InvalidSpecificationException is thrown when a method is called with non-sensical or contradictory...
Definition: hps.h:5852
Definition: hps.h:5892
Definition: sprk.h:66
Definition: sprk.h:213
ComponentIsolateEvent(Event const &in_event)
Definition: sprk.h:2496
Definition: sprk.h:682
Definition: sprk.h:105
virtual bool OnMouseMove(MouseState const &in_state)
Definition: sprk.h:1156
Definition: sprk.h:4246
virtual bool OnMouseEnter(MouseState const &in_state)
Definition: sprk.h:1166
Definition: sprk.h:3193
Definition: hps.h:42509
Definition: hps.h:1058
Definition: hps.h:1734
Definition: sprk.h:241
SmoothTransitionCompleteEvent(HPS::View const &in_view)
Definition: sprk.h:3400
std::vector< KeyPath, Allocator< KeyPath > > KeyPathArray
Array of type HPS::KeyPath.
Definition: hps.h:6707
Definition: sprk.h:4086
Definition: hps.h:48118
Definition: sprk.h:1067
Definition: hps.h:7747
Definition: hps.h:3563
Definition: hps.h:2100
Definition: sprk.h:919
bool HasAll(MouseButtons in_mouse_trigger, ModifierKeys in_modifier_trigger) const
Definition: sprk.h:2474
Definition: sprk.h:770
Definition: hps.h:1423
Definition: hps.h:879
Definition: hps.h:42629
SmoothTransitionCompleteEvent(Event const &in_event)
Definition: sprk.h:3405
Definition: hps.h:1792
Definition: hps.h:1558
Definition: hps.h:8983
Definition: hps.h:244
Definition: hps.h:1852
virtual void OnViewAttached(HPS::View const &in_attached_view)
Definition: sprk.h:1210
Definition: hps.h:48016
Definition: hps.h:41562
Definition: sprk.h:964
Definition: sprk.h:566
ViewDetachedEvent(Event const &in_event)
Definition: sprk.h:846
Definition: hps.h:41609
Definition: hps.h:40994
Definition: hps.h:44295
Definition: hps.h:1098
Definition: sprk.h:2878
Definition: sprk.h:2992
virtual bool OnMouseLeave(MouseState const &in_state)
Definition: sprk.h:1171
Definition: hps.h:9926
Definition: hps.h:42673
Definition: hps.h:1511
SmoothTransitionCompleteEvent()
Definition: sprk.h:3395
Definition: hps.h:1443
Definition: hps.h:1462
Definition: hps.h:38728
FilterActivationEvent(Event const &in_event)
Definition: sprk.h:2653
ModelDetachedEvent(Event const &in_event)
Definition: sprk.h:938
Definition: hps.h:7118
Definition: hps.h:47487
Definition: sprk.h:2943
Definition: sprk.h:1608
Definition: hps.h:44474
SprocketControl & operator=(SprocketControl &&in_that)
Definition: sprk.h:234
Definition: hps.h:46382
Definition: hps.h:47903
Definition: sprk.h:725
CaptureActivationEvent(Event const &in_event)
Definition: sprk.h:2742
virtual bool OnTouchDown(TouchState const &in_state)
Definition: sprk.h:1176
virtual bool OnMouseWheel(MouseState const &in_state)
Definition: sprk.h:1161
SprocketControl(SprocketControl &&in_that)
Definition: sprk.h:229
Definition: hps.h:15741
Definition: sprk.h:813
virtual bool Drop(Event const *in_that_event) const
Definition: sprk.h:3427
Definition: sprk.h:1746
Definition: hps.h:44753
Definition: hps.h:46994
The ComponentPath contains only components which are unique to this request, omitting ambiguous entri...
ViewDeletedEvent(Event const &in_event)
Definition: sprk.h:895
Definition: hps.h:38257
Definition: sprk.h:3090
Definition: hps.h:6325
Override the visibility for any components in the subtree under the ComponentPath specified regardles...
Definition: sprk.h:1312
Definition: hps.h:406
Definition: sprk.h:486
CanvasDeletedEvent(Event const &in_event)
Definition: sprk.h:701
Definition: sprk.h:2084
std::shared_ptr< Operator > OperatorPtr
Shared pointer to an Operator object.
Definition: sprk.h:83
virtual bool Drop(Event const *in_that_event) const
Definition: sprk.h:1039
Definition: hps.h:46307
std::vector< Key, Allocator< Key > > KeyArray
Array of type HPS::Key.
Definition: hps.h:6679
Definition: hps.h:2119
Definition: sprk.h:2524
LayoutDetachedEvent(Event const &in_event)
Definition: sprk.h:744
virtual bool OnMouseDown(MouseState const &in_state)
Definition: sprk.h:1146
Definition: sprk.h:2583
Definition: sprk.h:3244
Definition: sprk.h:190
virtual void OnViewDetached(HPS::View const &in_detached_view)
Definition: sprk.h:1214
Definition: sprk.h:3391
Definition: hps.h:425
Definition: sprk.h:2683
Definition: hps.h:2139
Definition: sprk.h:3589
Definition: sprk.h:3041
Definition: hps.h:9141
virtual bool IsMouseTriggered(MouseState const &in_state)
Definition: sprk.h:1240
Definition: hps.h:7665
Definition: sprk.h:2628
Definition: hps.h:37870
Definition: hps.h:351
ModelDeletedEvent(Event const &in_event)
Definition: sprk.h:983
LayoutDeletedEvent(Event const &in_event)
Definition: sprk.h:789
Definition: hps.h:9370
Definition: hps.h:11031
Definition: sprk.h:1255
virtual bool OnTouchMove(TouchState const &in_state)
Definition: sprk.h:1186
Definition: sprk.h:3870
Definition: sprk.h:2770
Definition: hps.h:43205
Definition: hps.h:511
Definition: sprk.h:1109
Definition: hps.h:1141
Definition: hps.h:42555
Definition: sprk.h:876
Definition: sprk.h:2724
Definition: hps.h:41058
Definition: hps.h:7376