OpenSceneGraph 3.6.5
Callback
Go to the documentation of this file.
1/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
2 *
3 * This library is open source and may be redistributed and/or modified under
4 * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
5 * (at your option) any later version. The full license is in LICENSE file
6 * included with this distribution, and on the openscenegraph.org website.
7 *
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * OpenSceneGraph Public License for more details.
12*/
13
14#ifndef OSG_CALLBACK
15#define OSG_CALLBACK 1
16
17#include <osg/Object>
18#include <osg/UserDataContainer>
19
20// forward declare
21namespace osgGA { class EventHandler; }
22
23namespace osg {
24
25// forward declare
26class CallbackObject;
27class NodeCallback;
28class StateAttributeCallback;
29class UniformCallback;
30class DrawableUpdateCallback;
31class DrawableEventCallback;
32class DrawableCullCallback;
33
34class OSG_EXPORT Callback : public virtual Object {
35
36 public :
37
39
40 Callback(const Callback& cb,const CopyOp& copyop):
41 osg::Object(cb, copyop),
43
45
46 virtual Callback* asCallback() { return this; }
47 virtual const Callback* asCallback() const { return this; }
48
49 virtual CallbackObject* asCallbackObject() { return 0; }
50 virtual const CallbackObject* asCallbackObject() const { return 0; }
51
52 virtual NodeCallback* asNodeCallback() { return 0; }
53 virtual const NodeCallback* asNodeCallback() const { return 0; }
54
56 virtual const StateAttributeCallback* asStateAttributeCallback() const { return 0; }
57
58 virtual UniformCallback* asUniformCallback() { return 0; }
59 virtual const UniformCallback* asUniformCallback() const { return 0; }
60
62 virtual const DrawableUpdateCallback* asDrawableUpdateCallback() const { return 0; }
63
65 virtual const DrawableEventCallback* asDrawableEventCallback() const { return 0; }
66
68 virtual const DrawableCullCallback* asDrawableCullCallback() const { return 0; }
69
70 virtual osgGA::EventHandler* asEventHandler() { return 0; }
71 virtual const osgGA::EventHandler* asEventHandler() const { return 0; }
72
80 virtual bool run(osg::Object* object, osg::Object* data)
81 {
82 return traverse(object, data);
83 }
84
86 bool traverse(osg::Object* object, osg::Object* data);
87
90 const osg::Callback* getNestedCallback() const { return _nestedCallback.get(); }
91
93 {
94 if (nc)
95 {
96 if (_nestedCallback.valid())
97 {
98 _nestedCallback->addNestedCallback(nc);
99 }
100 else
101 {
102 _nestedCallback = nc;
103 }
104 }
105 }
106
108 {
109 if (nc)
110 {
111 if (_nestedCallback==nc)
112 {
113 ref_ptr<osg::Callback> new_nested_callback = _nestedCallback->getNestedCallback();
114 _nestedCallback->setNestedCallback(0);
115 _nestedCallback = new_nested_callback;
116 }
117 else if (_nestedCallback.valid())
118 {
119 _nestedCallback->removeNestedCallback(nc);
120 }
121 }
122 }
123
124 protected:
125
126 virtual ~Callback() {}
128};
129
130typedef std::vector< osg::ref_ptr<osg::Object> > Parameters;
131
134{
135public:
137 CallbackObject(const std::string& name) { setName(name); }
139 osg::Object(co, copyop),
140 osg::Callback(co,copyop) {}
141
143
144 virtual CallbackObject* asCallbackObject() { return this; }
145 virtual const CallbackObject* asCallbackObject() const { return this; }
146
148 bool run(osg::Object* object, osg::Object* data);
149
150 inline bool run(osg::Object* object) const
151 {
152 osg::Parameters inputParameters;
153 osg::Parameters outputParameters;
154 return run(object, inputParameters, outputParameters);
155 }
156
157 virtual bool run(osg::Object* object, osg::Parameters& inputParameters, osg::Parameters& outputParameters) const;
158
159};
160
162inline CallbackObject* getCallbackObject(osg::Object* object, const std::string& name)
163{
165 if (!udc) return 0;
166
167 osg::Object* obj = udc->getUserObject(name);
168 if (!obj) return 0;
169
170 return obj->asCallbackObject();
171}
172
173
175inline const CallbackObject* getCallbackObject(const osg::Object* object, const std::string& name)
176{
177 const osg::UserDataContainer* udc = object->getUserDataContainer();
178 if (!udc) return 0;
179
180 const osg::Object* obj = udc->getUserObject(name);
181 if (!obj) return 0;
182
183 return obj->asCallbackObject();
184}
185
187inline bool runNamedCallbackObjects(osg::Object* object, const std::string& name, osg::Parameters& inputParameters, osg::Parameters& outputParameters)
188{
189 bool result = false;
191 if (udc)
192 {
193 for(unsigned int i = 0; i<udc->getNumUserObjects(); ++i)
194 {
195 osg::Object* obj = udc->getUserObject(i);
196 if (obj && obj->getName()==name)
197 {
199 if (co) result = co->run(object, inputParameters, outputParameters) | result;
200 }
201 }
202 }
203
204 return result;
205}
206
207
208
209// forward declare
210class Node;
211class NodeVisitor;
212
213
215class OSG_EXPORT NodeCallback : public virtual Callback {
216
217 public :
218
220
221 NodeCallback(const NodeCallback& nc,const CopyOp& copyop):
222 Object(nc, copyop),
223 Callback(nc, copyop) {}
224
226
227 virtual NodeCallback* asNodeCallback() { return this; }
228 virtual const NodeCallback* asNodeCallback() const { return this; }
229
231 virtual bool run(osg::Object* object, osg::Object* data);
232
234 virtual void operator()(Node* node, NodeVisitor* nv);
235
236 protected:
237
238 virtual ~NodeCallback() {}
239};
240
241// forward declare
242class StateAttribute;
243
246{
247 public:
249
251 Object(org, copyop),
252 Callback(org, copyop) {}
253
255
257 virtual const StateAttributeCallback* asStateAttributeCallback() const { return this; }
258
260 virtual bool run(osg::Object* object, osg::Object* data);
261
263 virtual void operator () (StateAttribute*, NodeVisitor*) {}
264};
265
266// forward declare
267class Uniform;
268
271{
272public:
274
275 UniformCallback(const UniformCallback& org, const CopyOp& copyop) :
276 Object(org, copyop),
277 Callback(org, copyop) {}
278
280
281 virtual UniformCallback* asUniformCallback() { return this; }
282 virtual const UniformCallback* asUniformCallback() const { return this; }
283
285 virtual bool run(osg::Object* object, osg::Object* data);
286
288 virtual void operator () (Uniform*, NodeVisitor*) {}
289};
290
291
292// forward declare
293class Drawable;
294class State;
295class RenderInfo;
296
298{
299public:
301
303 Object(org, copyop),
304 Callback(org, copyop) {}
305
307
309 virtual const DrawableUpdateCallback* asDrawableUpdateCallback() const { return this; }
310
312 virtual bool run(osg::Object* object, osg::Object* data);
313
316};
317
318
320{
321public:
323
325 Object(org, copyop),
326 Callback(org, copyop) {}
327
329
331 virtual const DrawableEventCallback* asDrawableEventCallback() const { return this; }
332
334 virtual bool run(osg::Object* object, osg::Object* data);
335
338};
339
341{
342public:
344
346 Object(org, copyop),
347 Callback(org, copyop) {}
348
350
352 virtual const DrawableCullCallback* asDrawableCullCallback() const { return this; }
353
354 // just use the standard run implementation to passes run onto any nested callbacks.
355 using Callback::run;
356
358 virtual bool cull(osg::NodeVisitor*, osg::Drawable*, osg::State*) const { return false; }
359
361 virtual bool cull(osg::NodeVisitor* nv, osg::Drawable* drawable, osg::RenderInfo* renderInfo) const;
362};
363
364
365} // namespace
366
367#endif
368
The core osg library provides the basic scene graph classes such as Nodes, State and Drawables,...
Definition AlphaFunc:19
bool runNamedCallbackObjects(osg::Object *object, const std::string &name, osg::Parameters &inputParameters, osg::Parameters &outputParameters)
Call run(..) on named CallbackObjects attached to specified Object.
Definition Callback:187
CallbackObject * getCallbackObject(osg::Object *object, const std::string &name)
Convenience function for getting the CallbackObject associated with specified name from an Object's U...
Definition Callback:162
std::vector< osg::ref_ptr< osg::Object > > Parameters
Definition Callback:130
The 'GA' in osgGA stands for 'GUI Abstraction'; the osgGA namespace provides facilities to help devel...
Definition Callback:21
Definition Callback:34
virtual DrawableCullCallback * asDrawableCullCallback()
Definition Callback:67
virtual UniformCallback * asUniformCallback()
Definition Callback:58
virtual CallbackObject * asCallbackObject()
Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
Definition Callback:49
virtual const CallbackObject * asCallbackObject() const
convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject,...
Definition Callback:50
virtual const Callback * asCallback() const
convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0.
Definition Callback:47
osg::Callback * getNestedCallback()
Definition Callback:89
virtual osgGA::EventHandler * asEventHandler()
Definition Callback:70
virtual const DrawableCullCallback * asDrawableCullCallback() const
Definition Callback:68
void addNestedCallback(osg::Callback *nc)
Definition Callback:92
bool traverse(osg::Object *object, osg::Object *data)
traverse the nested callbacks or call NodeVisitor::traverse() if the object is Node,...
virtual const StateAttributeCallback * asStateAttributeCallback() const
Definition Callback:56
ref_ptr< Callback > _nestedCallback
Definition Callback:127
Callback()
Definition Callback:38
virtual Callback * asCallback()
Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0.
Definition Callback:46
virtual DrawableEventCallback * asDrawableEventCallback()
Definition Callback:64
virtual const DrawableUpdateCallback * asDrawableUpdateCallback() const
Definition Callback:62
virtual StateAttributeCallback * asStateAttributeCallback()
Definition Callback:55
virtual bool run(osg::Object *object, osg::Object *data)
Invoke the callback, first parameter is the Object that the callback is attached to,...
Definition Callback:80
Callback(const Callback &cb, const CopyOp &copyop)
Definition Callback:40
const osg::Callback * getNestedCallback() const
Definition Callback:90
virtual const NodeCallback * asNodeCallback() const
Definition Callback:53
virtual DrawableUpdateCallback * asDrawableUpdateCallback()
Definition Callback:61
virtual NodeCallback * asNodeCallback()
Definition Callback:52
virtual const DrawableEventCallback * asDrawableEventCallback() const
Definition Callback:65
virtual const UniformCallback * asUniformCallback() const
Definition Callback:59
META_Object(osg, Callback)
virtual ~Callback()
Definition Callback:126
void setNestedCallback(osg::Callback *cb)
Definition Callback:88
virtual const osgGA::EventHandler * asEventHandler() const
Definition Callback:71
void removeNestedCallback(osg::Callback *nc)
Definition Callback:107
Callback for attaching a script to a Node's via there UserDataContainer for the purpose of overriding...
Definition Callback:134
CallbackObject()
Definition Callback:136
virtual CallbackObject * asCallbackObject()
Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
Definition Callback:144
bool run(osg::Object *object, osg::Object *data)
override Callback::run() entry point to adapt to CallbackObject::run(..) method.
virtual const CallbackObject * asCallbackObject() const
convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject,...
Definition Callback:145
META_Object(osg, CallbackObject)
CallbackObject(const std::string &name)
Definition Callback:137
bool run(osg::Object *object) const
Definition Callback:150
CallbackObject(const CallbackObject &co, const osg::CopyOp copyop=osg::CopyOp::SHALLOW_COPY)
Definition Callback:138
virtual bool run(osg::Object *object, osg::Parameters &inputParameters, osg::Parameters &outputParameters) const
Deprecated.
Definition Callback:215
virtual void operator()(Node *node, NodeVisitor *nv)
Callback method called by the NodeVisitor when visiting a node.
NodeCallback(const NodeCallback &nc, const CopyOp &copyop)
Definition Callback:221
virtual bool run(osg::Object *object, osg::Object *data)
NodeCallback overrides the Callback::run() method to adapt it the old style NodeCallback::operator()(...
NodeCallback()
Definition Callback:219
virtual const NodeCallback * asNodeCallback() const
Definition Callback:228
META_Object(osg, NodeCallback)
virtual NodeCallback * asNodeCallback()
Definition Callback:227
virtual ~NodeCallback()
Definition Callback:238
Deprecated.
Definition Callback:246
virtual StateAttributeCallback * asStateAttributeCallback()
Definition Callback:256
virtual bool run(osg::Object *object, osg::Object *data)
override Callback::run() entry point to adapt to StateAttributeCallback::run(..) method.
StateAttributeCallback()
Definition Callback:248
META_Object(osg, StateAttributeCallback)
virtual const StateAttributeCallback * asStateAttributeCallback() const
Definition Callback:257
StateAttributeCallback(const StateAttributeCallback &org, const CopyOp &copyop)
Definition Callback:250
Deprecated.
Definition Callback:271
virtual UniformCallback * asUniformCallback()
Definition Callback:281
META_Object(osg, UniformCallback)
UniformCallback()
Definition Callback:273
virtual const UniformCallback * asUniformCallback() const
Definition Callback:282
virtual bool run(osg::Object *object, osg::Object *data)
override Callback::run() entry point to adapt to UniformCallback::run(..) method.
UniformCallback(const UniformCallback &org, const CopyOp &copyop)
Definition Callback:275
Definition Callback:298
META_Object(osg, DrawableUpdateCallback)
DrawableUpdateCallback()
Definition Callback:300
DrawableUpdateCallback(const DrawableUpdateCallback &org, const CopyOp &copyop)
Definition Callback:302
virtual const DrawableUpdateCallback * asDrawableUpdateCallback() const
Definition Callback:309
virtual DrawableUpdateCallback * asDrawableUpdateCallback()
Definition Callback:308
virtual bool run(osg::Object *object, osg::Object *data)
override Callback::run() entry point to adapt to StateAttributeCallback::run(..) method.
virtual void update(osg::NodeVisitor *, osg::Drawable *)
do customized update code.
Definition Callback:315
Definition Callback:320
virtual DrawableEventCallback * asDrawableEventCallback()
Definition Callback:330
virtual const DrawableEventCallback * asDrawableEventCallback() const
Definition Callback:331
DrawableEventCallback(const DrawableEventCallback &org, const CopyOp &copyop)
Definition Callback:324
virtual void event(osg::NodeVisitor *, osg::Drawable *)
do customized Event code.
Definition Callback:337
META_Object(osg, DrawableEventCallback)
DrawableEventCallback()
Definition Callback:322
virtual bool run(osg::Object *object, osg::Object *data)
override Callback::run() entry point to adapt to StateAttributeCallback::run(..) method.
Definition Callback:341
virtual const DrawableCullCallback * asDrawableCullCallback() const
Definition Callback:352
META_Object(osg, DrawableCullCallback)
virtual bool cull(osg::NodeVisitor *, osg::Drawable *, osg::State *) const
deprecated.
Definition Callback:358
virtual bool cull(osg::NodeVisitor *nv, osg::Drawable *drawable, osg::RenderInfo *renderInfo) const
do customized cull code, return true if drawable should be culled.
virtual DrawableCullCallback * asDrawableCullCallback()
Definition Callback:351
DrawableCullCallback()
Definition Callback:343
DrawableCullCallback(const DrawableCullCallback &org, const CopyOp &copyop)
Definition Callback:345
Copy Op(erator) used to control whether shallow or deep copy is used during copy construction and clo...
Definition CopyOp:41
@ SHALLOW_COPY
Definition CopyOp:47
Pure virtual base class for drawable geometry.
Definition Drawable:89
Base class for all internal nodes in the scene graph.
Definition Node:72
Visitor for type safe operations on osg::Nodes.
Definition NodeVisitor:82
Base class/standard interface for objects which require IO support, cloning and reference counting.
Definition Object:61
virtual void setName(const std::string &name)
Set the name of object using C++ style string.
Definition Object:203
Object()
Construct an object.
Definition Object:69
virtual CallbackObject * asCallbackObject()
Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
Definition Object:167
osg::UserDataContainer * getUserDataContainer()
get the UserDataContainer attached to this object.
Definition Object:243
const std::string & getName() const
Get the name of object.
Definition Object:213
Smart pointer for handling referenced counted objects.
Definition ref_ptr:32
Definition RenderInfo:28
Encapsulates the current applied OpenGL modes, attributes and vertex arrays settings,...
Definition State:80
Base class for state attributes.
Definition StateAttribute:77
Uniform encapsulates glUniform values.
Definition Uniform:414
Internal structure for storing all user data.
Definition UserDataContainer:26
virtual unsigned int getNumUserObjects() const =0
Get number of user objects assigned to this object.
virtual Object * getUserObject(unsigned int i)=0
Get user data object as specified index position.
EventHandler is base class for adding handling of events, either as node event callback,...
Definition EventHandler:34
#define OSG_EXPORT
Definition Export:39

osg logo
Generated at Sun Jul 20 2025 00:00:00 for the OpenSceneGraph by doxygen 1.14.0.