sprk.h
19 # pragma warning(disable: 4251) //Not an issue as long as debug and release libraries aren't mixed
100 typedef std::vector<HighlightOptionsKit, Allocator<HighlightOptionsKit>> HighlightOptionsKitArray;
178 UpdateNotifier UpdateWithNotifier(HPS::Window::UpdateType in_type, HPS::Time in_time_limit = -1.0) const;
311 HPS::View & ComputeFitWorldCamera(BoundingKit const & in_bounding, HPS::CameraKit & out_camera);
318 HPS::View & ComputeFitWorldCamera(SegmentKey const & in_segment, MatrixKit const & in_transform, HPS::CameraKit & out_camera);
326 HPS::View & ComputeFitWorldCamera(BoundingKit const & in_bounding, MatrixKit const & in_transform, HPS::CameraKit & out_camera);
466 UpdateNotifier UpdateWithNotifier(HPS::Window::UpdateType in_type, HPS::Time in_time_limit = -1.0) const;
557 UpdateNotifier UpdateWithNotifier(HPS::Window::UpdateType in_type, HPS::Time in_time_limit = -1.0) const;
593 void AttachViewFront(View const & in_view, HPS::Rectangle const & in_position = HPS::Rectangle(-1.0f, 1.0f, -1.0f, 1.0f));
597 void AttachViewBack(View const & in_view, HPS::Rectangle const & in_position = HPS::Rectangle(-1.0f, 1.0f, -1.0f, 1.0f));
676 UpdateNotifier UpdateWithNotifier(HPS::Window::UpdateType in_type, HPS::Time in_time_limit = -1.0) const;
836 : Event(), layout(in_layout), action(Action::AllLayers), layer(std::numeric_limits<size_t>::max()), view(in_view)
1039 CameraChangedEvent const * that_event = static_cast<CameraChangedEvent const *>(in_that_event);
1069 SprocketPath(Model const & in_model, View const & in_view, Layout const & in_layout, Canvas const & in_canvas);
1070 SprocketPath(Canvas const & in_canvas, Layout const & in_layout, View const & in_view, Model const & in_model);
1110 Operator(MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys());
1144 virtual bool OnMouseDown(MouseState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1149 virtual bool OnMouseUp(MouseState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1154 virtual bool OnMouseMove(MouseState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1159 virtual bool OnMouseWheel(MouseState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1164 virtual bool OnMouseEnter(MouseState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1169 virtual bool OnMouseLeave(MouseState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1174 virtual bool OnTouchDown(TouchState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1179 virtual bool OnTouchUp(TouchState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1184 virtual bool OnTouchMove(TouchState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1189 virtual bool OnKeyDown(KeyboardState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1194 virtual bool OnKeyUp(KeyboardState const & in_state) { HPS_UNREFERENCED(in_state); return false; }
1199 virtual bool OnTextInput(HPS::UTF8 const & in_text) { HPS_UNREFERENCED(in_text); return false; }
1204 virtual bool OnTimerTick(HPS::TimerTickEvent const & in_event) { HPS_UNREFERENCED(in_event); return false; }
1208 virtual void OnViewAttached(HPS::View const & in_attached_view) { HPS_UNREFERENCED(in_attached_view); return; }
1212 virtual void OnViewDetached(HPS::View const & in_detached_view) { HPS_UNREFERENCED(in_detached_view); return; }
1238 virtual bool IsMouseTriggered(MouseState const & in_state) { return in_state.HasAll(mouse_trigger, modifier_trigger); }
1352 OperatorControl & Push(OperatorPtr const & in_operator, Operator::Priority in_priority = Operator::Priority::Default);
1360 OperatorControl & Push(Operator * in_operator, Operator::Priority in_priority = Operator::Priority::Default);
1386 OperatorControl & Set(OperatorPtr const & in_operator, Operator::Priority in_priority = Operator::Priority::Default);
1394 OperatorControl & Set(Operator * in_operator, Operator::Priority in_priority = Operator::Priority::Default);
1401 OperatorControl & Set(OperatorPtrArray & in_operators, Operator::Priority in_priority = Operator::Priority::Default);
1409 OperatorControl & Set(size_t in_count, OperatorPtr in_operators [], Operator::Priority in_priority = Operator::Priority::Default);
1505 NavigationCubeControl & SetLocation(Location in_location, HPS::Rectangle const & in_rectangle = HPS::Rectangle(), HPS::IntRectangle in_offsets = HPS::IntRectangle::Zero());
1603 * \param in_fallback_fonts An array of fonts to use in case the one specified in in_text_attributes cannot be found at runtime.
1605 * If the font specified is not found at runtime, and no fallback fonts are specified, a stroked representation of the text will be
1608 NavigationCubeControl & SetText(const char * in_back_string, const char * in_top_string, const char * in_left_string,
1610 HPS::TextAttributeKit const & in_text_attributes, HPS::UTF8Array const & in_fallback_fonts = HPS::UTF8Array());
1620 * \param out_fallback_fonts The fonts that will be used if the preferred font specified when setting text could not be found at runtime. Can be empty.
1621 * \return <span class='code'>true</span> if the navigation cube text was retrieved successfully, <span class='code'>false</span> otherwise. */
1689 HPS::AxisTriadControl & SetLocation(Location in_location, HPS::Rectangle const & in_position = HPS::Rectangle(), HPS::IntRectangle in_offsets = HPS::IntRectangle::Zero());
1883 Standard, // subcomponents will be deleted if they don't have multiple owners, otherwise their reference count will be decremented
1885 StandardAndExchange // Subcomponent will deleted if they don't have multiple owners, otherwise their reference count will be decremented.
2295 void Highlight(Canvas const & in_canvas, HighlightOptionsKit const & in_options, bool in_remove_existing = true) const;
2303 void Highlight(Canvas const & in_canvas, size_t in_layer, HighlightOptionsKit const & in_options, bool in_remove_existing = true) const;
2308 void Unhighlight(Canvas const & in_canvas, HighlightOptionsKit const & in_options = HighlightOptionsKit()) const;
2314 void Unhighlight(Canvas const & in_canvas, size_t in_layer, HighlightOptionsKit const & in_options = HighlightOptionsKit()) const;
2379 static void Isolate(HPS::ComponentPathArray & in_component_paths, Canvas const & in_canvas, size_t in_layer = 0);
2402 static void ResetVisibility(HPS::ComponentPathArray & in_component_paths, Canvas const & in_canvas, size_t in_layer = 0);
2408 /* Access a Component in this ComponentPath object. An HPS::IndexOutOfRangeException exception is thrown if in_index is out of range.
2413 /* Access a Component in this ComponentPath object. An HPS::IndexOutOfRangeException exception is thrown if in_index is out of range.
2418 /* Inserts in_item in the ComponentPath before the element at position in_index, increasing the size of the ComponentPath by one.
2424 /* Traverses the components in this ComponentPath and removes the first one which matches in_item
2429 /* Removes the the component at position in_index from this ComponentPath. An HPS::IndexOutOfRangeException exception is thrown if in_index is out of range.
2433 /* Creates and returns a new ComponentPath object, with the components organized in the reverse order.
2437 /* Returns the first component of this ComponentPath. An HPS::IndexOutOfRangeException exception is thrown if the ComponentPath is empty.
2441 /* Returns the first component of this ComponentPath. An HPS::IndexOutOfRangeException exception is thrown if the ComponentPath is empty.
2445 /* Returns the last component of this ComponentPath. An HPS::IndexOutOfRangeException exception is thrown if the ComponentPath is empty.
2449 /* Returns the last component of this ComponentPath. An HPS::IndexOutOfRangeException exception is thrown if the ComponentPath is empty.
2453 /* Returns the first component of this ComponentPath and returns it. An HPS::IndexOutOfRangeException exception is thrown if the ComponentPath is empty.
2457 /* Returns the last component of this ComponentPath and returns it. An HPS::IndexOutOfRangeException exception is thrown if the ComponentPath is empty.
2496 * \return A constant iterator pointing to the last Component contained in this ComponentPath. */
2500 * \return A constant iterator pointing to the last Component contained in this ComponentPath. */
2504 * \return A constant iterator pointing to the first Component contained in this ComponentPath. */
2508 * \return A constant iterator pointing to the last Component contained in this ComponentPath. */
2512 * \return A reverse iterator pointing to the last Component contained in this ComponentPath. */
2516 * \return A reverse iterator pointing to the first Component contained in this ComponentPath. */
2519 /* Returns a constant reverse iterator pointing to the last Component contained in this ComponentPath
2520 * \return A constant reverse iterator pointing to the last Component contained in this ComponentPath. */
2524 * \return A constant iterator pointing to the first Component contained in this ComponentPath. */
2622 ComponentResetEvent(HPS::ComponentPath const & in_path, HPS::Canvas const & in_canvas, size_t in_layer = 0)
2666 ComponentShownEvent(HPS::ComponentPath const & in_path, HPS::Canvas const & in_canvas, size_t in_layer = 0)
2710 ComponentHiddenEvent(HPS::ComponentPath const & in_path, HPS::Canvas const & in_canvas, size_t in_layer = 0)
2755 ComponentIsolatedEvent(HPS::ComponentPath const & in_path, HPS::Canvas const & in_canvas, size_t in_layer = 0)
2817 : Event(), action(in_action), path(in_path), options(in_options), canvas(in_canvas), layer(in_layer)
2921 FilterActivationEvent(Filter in_filter, Action in_action, View in_view) : Event(), filter(in_filter), action(in_action), view(in_view)
3010 CaptureActivationEvent(Capture in_capture, View in_view) : Event(), capture(in_capture), view(in_view)
3100 ComponentPath GetComponentPath(KeyPath const & in_key_path, ComponentPath::PathType in_path_type = ComponentPath::PathType::Unique) const;
3113 ComponentPath GetComponentPath(SelectionItem const & in_item, ComponentPath::PathType in_path_type = ComponentPath::PathType::Unique) const;
3549 static Canvas CreateCanvas(HPS::WindowHandle in_window_handle, char const * in_name = "", HPS::ApplicationWindowOptionsKit const & in_options = HPS::ApplicationWindowOptionsKit());
3557 static Canvas CreateCanvas(char const * in_name = "", HPS::StandAloneWindowOptionsKit const & in_options = HPS::StandAloneWindowOptionsKit());
3565 static Canvas CreateCanvas(HPS::WindowKey const & in_window_key, HPS::PortfolioKey const & in_portfolio_key = HPS::PortfolioKey(), char const * in_name = "");
3611 AxisTriadOperator(MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys());
3736 NavigationCubeOperator(MouseButtons in_mouse_trigger = MouseButtons::ButtonLeft(), ModifierKeys in_modifier_trigger = ModifierKeys());
4200 SceneTreeItem(SceneTreePtr const & in_tree, Key const & in_key, SceneTree::ItemType in_type, char const * in_title = nullptr);
4276 virtual SceneTreeItemPtr AddChild(Key const & in_key, SceneTree::ItemType in_type, char const * in_title = nullptr) = 0;
4554 ComponentTreeItem(ComponentTreePtr const & in_tree, Component const & in_component, ComponentTree::ItemType in_type);
4625 virtual ComponentTreeItemPtr AddChild(Component const & in_component, ComponentTree::ItemType in_type) = 0;
Definition: sprk.h:3415
Definition: hps.h:3488
Definition: hps.h:6352
Definition: hps.h:85
Definition: sprk.h:1005
ComponentIsolatedEvent(Event const &in_event)
Definition: sprk.h:2764
Definition: sprk.h:2744
Definition: sprk.h:3608
Definition: sprk.h:273
ComponentHighlightEvent(Event const &in_event)
Definition: sprk.h:2825
virtual bool OnTimerTick(HPS::TimerTickEvent const &in_event)
Definition: sprk.h:1204
Definition: hps.h:43446
ComponentHighlightEvent()
Definition: sprk.h:2805
void SetModifierTrigger(ModifierKeys in_modifiers)
Definition: sprk.h:1232
Definition: hps.h:474
CameraChangedEvent(Event const &in_event)
Definition: sprk.h:1024
virtual bool OnKeyDown(KeyboardState const &in_state)
Definition: sprk.h:1189
std::vector< SegmentKey, Allocator< SegmentKey > > SegmentKeyArray
Array of type HPS::SegmentKey.
Definition: hps.h:6780
An InvalidSpecificationException is thrown when a method is called with non-sensical or contradictory...
Definition: hps.h:5956
Definition: hps.h:5996
Definition: sprk.h:67
Definition: sprk.h:214
Definition: sprk.h:680
Definition: sprk.h:106
virtual bool OnMouseMove(MouseState const &in_state)
Definition: sprk.h:1154
Definition: sprk.h:4527
virtual bool OnMouseEnter(MouseState const &in_state)
Definition: sprk.h:1164
Definition: sprk.h:3469
Definition: hps.h:43229
virtual bool Drop(Event const *in_that_event) const
Definition: sprk.h:1037
Definition: hps.h:1067
Definition: hps.h:1766
Definition: sprk.h:242
SmoothTransitionCompleteEvent(HPS::View const &in_view)
Definition: sprk.h:3679
std::vector< KeyPath, Allocator< KeyPath > > KeyPathArray
Array of type HPS::KeyPath.
Definition: hps.h:6818
Definition: sprk.h:4367
Definition: hps.h:48994
Definition: sprk.h:1065
Definition: hps.h:7863
Definition: hps.h:3639
Definition: hps.h:2142
Definition: sprk.h:917
bool HasAll(MouseButtons in_mouse_trigger, ModifierKeys in_modifier_trigger) const
Definition: sprk_ops.h:20
Definition: sprk.h:768
Definition: hps.h:1455
Definition: hps.h:887
Definition: hps.h:43349
SmoothTransitionCompleteEvent(Event const &in_event)
Definition: sprk.h:3684
Definition: hps.h:1824
Definition: hps.h:1590
Definition: hps.h:9107
Definition: hps.h:244
Definition: hps.h:1893
Definition: sprk.h:39
virtual void OnViewAttached(HPS::View const &in_attached_view)
Definition: sprk.h:1208
Definition: hps.h:48892
Definition: hps.h:42261
Definition: sprk.h:962
Definition: sprk.h:564
ViewDetachedEvent(Event const &in_event)
Definition: sprk.h:844
Definition: hps.h:42308
Definition: hps.h:41693
Definition: hps.h:45015
Definition: hps.h:1107
Definition: sprk.h:3154
Definition: sprk.h:3268
virtual bool OnMouseLeave(MouseState const &in_state)
Definition: sprk.h:1169
Definition: hps.h:10079
Definition: hps.h:43393
Definition: hps.h:1543
SmoothTransitionCompleteEvent()
Definition: sprk.h:3674
Definition: hps.h:1475
Definition: hps.h:1494
Definition: hps.h:39276
FilterActivationEvent(Event const &in_event)
Definition: sprk.h:2929
ModelDetachedEvent(Event const &in_event)
Definition: sprk.h:936
Definition: hps.h:7234
Definition: hps.h:48363
Definition: sprk.h:3219
Definition: sprk.h:1643
Definition: hps.h:45194
SprocketControl & operator=(SprocketControl &&in_that)
Definition: sprk.h:235
Definition: hps.h:47253
Definition: hps.h:44274
Definition: hps.h:48779
Definition: sprk.h:723
CaptureActivationEvent(Event const &in_event)
Definition: sprk.h:3018
virtual bool OnTouchDown(TouchState const &in_state)
Definition: sprk.h:1174
virtual bool OnMouseWheel(MouseState const &in_state)
Definition: sprk.h:1159
SprocketControl(SprocketControl &&in_that)
Definition: sprk.h:230
Definition: hps.h:15953
Definition: sprk.h:811
Definition: sprk.h:1783
Definition: hps.h:45481
Definition: hps.h:47870
The ComponentPath contains only components which are unique to this request, omitting ambiguous entri...
ViewDeletedEvent(Event const &in_event)
Definition: sprk.h:893
Definition: hps.h:38779
Definition: sprk.h:3366
Definition: hps.h:6436
Definition: hps.h:14201
std::vector< UTF8, Allocator< UTF8 > > UTF8Array
Array of type HPS::UTF8.
Definition: hps.h:6786
Definition: sprk.h:1310
Definition: hps.h:410
Definition: sprk.h:484
CanvasDeletedEvent(Event const &in_event)
Definition: sprk.h:699
Definition: sprk.h:2153
std::shared_ptr< Operator > OperatorPtr
Shared pointer to an Operator object.
Definition: sprk.h:84
Definition: hps.h:47178
std::vector< Key, Allocator< Key > > KeyArray
Array of type HPS::Key.
Definition: hps.h:6790
Definition: hps.h:2161
Definition: sprk.h:2794
LayoutDetachedEvent(Event const &in_event)
Definition: sprk.h:742
virtual bool OnMouseDown(MouseState const &in_state)
Definition: sprk.h:1144
Definition: sprk.h:2859
Definition: sprk.h:3520
Definition: sprk.h:191
virtual void OnViewDetached(HPS::View const &in_detached_view)
Definition: sprk.h:1212
Definition: sprk.h:3670
Definition: hps.h:429
Definition: sprk.h:2959
Definition: hps.h:2181
Definition: sprk.h:3870
Definition: sprk.h:2612
Definition: sprk.h:3317
Definition: hps.h:9265
virtual bool IsMouseTriggered(MouseState const &in_state)
Definition: sprk.h:1238
Definition: hps.h:7781
Definition: sprk.h:2904
Definition: hps.h:38379
Definition: hps.h:355
ModelDeletedEvent(Event const &in_event)
Definition: sprk.h:981
LayoutDeletedEvent(Event const &in_event)
Definition: sprk.h:787
Definition: hps.h:9494
Definition: hps.h:11184
Definition: sprk.h:1253
virtual bool OnTouchMove(TouchState const &in_state)
Definition: sprk.h:1184
virtual bool Drop(Event const *in_that_event) const
Definition: sprk.h:3706
Definition: sprk.h:4151
Definition: sprk.h:3046
Definition: sprk.h:2656
Definition: hps.h:43925
Definition: hps.h:515
Definition: sprk.h:1107
Definition: hps.h:1173
Definition: hps.h:43275
Definition: sprk.h:874
Definition: sprk.h:3000
Definition: hps.h:41757
Definition: hps.h:7492