vsg: include/vsg/app/UpdateOperations.h Source File

vsg 1.1.8 VulkanSceneGraph library

Loading...
Searching...
No Matches
UpdateOperations.h
1#pragma once
2
3/* <editor-fold desc="MIT License">
4
5Copyright(c) 2022 Robert Osfield
6
7Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
8
9The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
10
11THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
12
13</editor-fold> */
14
15#include <vsg/threading/OperationQueue.h>
16
17#include <list>
18#include <mutex>
19
20namespace vsg
21{
22
24 class VSG_DECLSPEC UpdateOperations : public Inherit<Object, UpdateOperations>
25 {
26 public:
27 UpdateOperations();
28
30 enum RunBehavior
31 {
32 ONE_TIME,
33 ALL_FRAMES
34 };
35
36 using value_type = ref_ptr<Operation>;
37 using container_type = std::list<value_type>;
38
40 virtual void add(ref_ptr<Operation> op, RunBehavior runBehavior = ONE_TIME);
41
43 virtual void remove(ref_ptr<Operation> op);
44
46 void clear();
47
49 container_type getUpdateOperationsOneTime() const;
50
52 container_type getUpdateOperationsAllFrames() const;
53
55 virtual void run();
56
57 protected:
58 virtual ~UpdateOperations();
59
60 mutable std::mutex _updateOperationMutex;
61 std::list<ref_ptr<Operation>> _updateOperationsOneTime;
62 std::list<ref_ptr<Operation>> _updateOperationsAllFrames;
63 };
64 VSG_type_name(vsg::UpdateOperations);
65
66} // namespace vsg
vsg::Inherit
Definition Inherit.h:28
vsg::UpdateOperations
class for managing thread safe adding and running of update operations
Definition UpdateOperations.h:25
vsg::UpdateOperations::clear
void clear()
clear all update operations
vsg::UpdateOperations::getUpdateOperationsOneTime
container_type getUpdateOperationsOneTime() const
get a copy of all current one time updated operations
vsg::UpdateOperations::remove
virtual void remove(ref_ptr< Operation > op)
remove operation
vsg::UpdateOperations::RunBehavior
RunBehavior
specification of whether update operation should be invoked once or on all frames
Definition UpdateOperations.h:31
vsg::UpdateOperations::add
virtual void add(ref_ptr< Operation > op, RunBehavior runBehavior=ONE_TIME)
add operation
vsg::UpdateOperations::getUpdateOperationsAllFrames
container_type getUpdateOperationsAllFrames() const
get a copy of all current all frames updated operations
vsg::UpdateOperations::run
virtual void run()
run is invoked by Viewer::update()
vsg::ref_ptr
Definition ref_ptr.h:22