GxSeparator Class Reference
#include <gfx/gxseparator.h>
Public Types | |
| typedef unsigned int | ChildId |
| Index type to refer to child nodes. | |
Public Member Functions | |
| virtual | ~GxSeparator () throw () |
| Virtual destructor. | |
| virtual void | read_from (io::reader &reader) |
| virtual void | write_to (io::writer &writer) const |
| ChildId | addChild (nub::ref< GxNode > item) |
| Add the given child node, and return its index. | |
| void | insertChild (nub::ref< GxNode > item, ChildId at_index) |
| Insert the given child at the given index. | |
| void | removeChildAt (ChildId index) |
| Remove the child at the given index. | |
| void | removeChild (nub::ref< GxNode > item) |
| Remove the child matching the given node. | |
| unsigned int | numChildren () const |
| Get the number of child nodes. | |
| nub::ref< GxNode > | getChild (ChildId index) const |
| Get the child node at the given index. | |
|
rutz::fwd_iter< nub::ref < GxNode > > | children () const |
| Get an iterator of all the child nodes. | |
| virtual rutz::fwd_iter< const nub::ref< GxNode > > | deepChildren () |
| virtual bool | contains (GxNode *other) const |
| virtual void | getBoundingCube (Gfx::Bbox &bbox) const |
| Apply all of the contained objects' transformations to the cube. | |
| bool | getDebugMode () const |
| Query whether debug-mode drawing is turned on. | |
| void | setDebugMode (bool b) |
| Turn debug-mode drawing on or off. | |
| virtual void | draw (Gfx::Canvas &canvas) const |
| Draw all of the contained objects on canvas. | |
| geom::rect< double > | getBoundingBox (Gfx::Canvas &canvas) const |
| Get the 2-D z-projection of the result of getBoundingCube(). | |
| void | undraw (Gfx::Canvas &canvas) const |
| Undraw the object from canvas by clearing the bounding box. | |
| virtual io::version_id | class_version_id () const |
| nub::uid | id () const throw () |
| rutz::fstring | real_typename () const |
| Returns the typename of the full object. | |
| virtual rutz::fstring | obj_typename () const |
| Returns the (apparent) typename of the full object. | |
| rutz::fstring | unique_name () const |
| Returns a short string describing the object by its typename and id. | |
| void * | operator new (size_t bytes) |
| void | operator delete (void *space, size_t bytes) |
| void | mark_as_volatile () throw () |
| Mark this object as a volatile (unshareable) object. | |
| void | incr_ref_count () const throw () |
| Increment the object's reference count. | |
| void | decr_ref_count () const throw () |
| Decrement the object's reference count. | |
| void | decr_ref_count_no_delete () const throw () |
| Decrement the object's reference count, but don't delete it. | |
| bool | is_shared () const throw () |
| Returns true if no external client has sole ownership of the object. | |
| bool | is_unshared () const throw () |
| Returns true if there is a sole external owner of the object. | |
| bool | is_not_shareable () const throw () |
| ref_counts * | get_counts () const throw () |
| Returns the object's reference count manager. | |
| int | dbg_ref_count () const throw () |
| FOR TEST/DEBUG ONLY! Returns the object's (strong) reference count. | |
| int | dbg_weak_ref_count () const throw () |
| FOR TEST/DEBUG ONLY! Returns the object's weak reference count. | |
Static Public Member Functions | |
| static GxSeparator * | make () |
| Factory function. | |
Public Attributes | |
| nub::signal0 | sigNodeChanged |
| Signal that will be triggered whenever the node changes state. | |
Protected Member Functions | |
| GxSeparator () | |
| Default constructor. | |
Classes | |
| class | Impl |
Detailed Description
GxSeparator is a subclass of GxNode that holds a list of children, and can be used to implement arbitrary tree structured hierarchies of GxNode's. GxSeparator saves the OpenGL state before drawing or undrawing its children, and restores the state when it is done handling its children.Definition at line 57 of file gxseparator.h.
Member Function Documentation
| void GxSeparator::read_from | ( | io::reader & | reader | ) | [virtual] |
Subclasses implement this method to save the object's state via the generic interface provided by io::reader. Parsing the format of the input is handled by the io::reader, so implementors of read_from() of don't need to deal with formatting.
Implements io::serializable.
Definition at line 128 of file gxseparator.cc.
References nub::signal0::emit(), GxNode::sigNodeChanged, and nub::signal0::slot().
| void GxSeparator::write_to | ( | io::writer & | writer | ) | const [virtual] |
Subclasses implement this method to restore the object's state via the generic interface provided by io::writer. Formatting the output is handled by the io::writer, so implementors of write_to() of don't need to deal with formatting.
Implements io::serializable.
Definition at line 151 of file gxseparator.cc.
References io::write_utils::write_object_seq().
| rutz::fwd_iter< const nub::ref< GxNode > > GxSeparator::deepChildren | ( | ) | [virtual] |
Returns an iterator to all the children recursively contained in this object.
Reimplemented from GxNode.
Definition at line 293 of file gxseparator.cc.
| bool GxSeparator::contains | ( | GxNode * | other | ) | const [virtual] |
Returns true if other is contained within this node in the scene graph. The default implementation (for leaf nodes) returns true only if this == other. For composite nodes, the function will check recursively is other is contained within the composite structure. This function is used to avoid generated cycles in the scene graph.
Reimplemented from GxNode.
Definition at line 301 of file gxseparator.cc.
| io::version_id io::serializable::class_version_id | ( | ) | const [virtual, inherited] |
Returns a serialization version id for the class. The default implementation returns zero. Classes should override this when they make a change that requires a change to their serialization protocol. Overriding versions of this function should follow the convention that a higher id refers to a later version of the class. Implementations of io::reader and io::writer will provide a way for a class to store and retrieve the serialization version of an object.
Reimplemented in GxCache, GxPerspectiveCamera, GxFixedScaleCamera, GxPsyphyCamera, GxColor, GxCylinder, GxDisk, GxDrawStyle, GxLighting, GxLine, GxMaterial, GxPixmap, GxPointSet, GxShapeKit, GxSphere, GxText, GxTransform, io::proxy< C >, io::const_proxy< C >, Block, CloneFace, EventResponseHdlr, ExptDriver, Face, Fish, FixPt, Gabor, GaborArray, House, Jitter, MaskHatch, MorphyFace, TimingHandler, TimingHdlr, and Trial.
| nub::uid nub::object::id | ( | ) | const throw () [inherited] |
| rutz::fstring nub::object::real_typename | ( | ) | const [inherited] |
Returns the typename of the full object.
The result is a demangled version of typeid(*this).name(), which should very closely resemble the way the object was declared in source code.
Definition at line 67 of file object.cc.
References rutz::demangled_name().
Referenced by nub::object::obj_typename().
| rutz::fstring nub::object::obj_typename | ( | ) | const [virtual, inherited] |
Returns the (apparent) typename of the full object.
The default implementation just returns real_typename(). However, certain kinds of objects -- e.g., proxy objects -- might usefully choose to have obj_typename() return something besides the real_typename(), in order to masquerade as a different type of object.
Reimplemented in io::proxy< C >, io::const_proxy< C >, MtxObj, and TrialMemFuncEvent.
Definition at line 73 of file object.cc.
References nub::object::real_typename().
Referenced by io::legacy_reader::read_root(), and nub::object::unique_name().
| void * nub::ref_counted::operator new | ( | size_t | bytes | ) | [inherited] |
Class-specific operator new; protected to ensure that clients use factory functions.
Definition at line 157 of file refcounted.cc.
| void nub::ref_counted::operator delete | ( | void * | space, | |
| size_t | bytes | |||
| ) | [inherited] |
Class-specific operator delete; private since deletion should only happen in ref_counted::decr_ref_count.
Definition at line 163 of file refcounted.cc.
| void nub::ref_counted::incr_ref_count | ( | ) | const throw () [inherited] |
Increment the object's reference count.
This operation (on the strong reference count) is not permitted if the object is unshareable. Unshareable objects can only have their weak reference counts manipulated.
Definition at line 207 of file refcounted.cc.
References nub::ref_counts::acquire_strong().
Referenced by GxEmptyNode::make().
| void nub::ref_counted::decr_ref_count | ( | ) | const throw () [inherited] |
Decrement the object's reference count.
If this causes the reference count to fall to zero or below, the pointee and the pointer will be destroyed by a call to 'delete this'. This operation (on the strong reference count) is not permitted if the object is unshareable. Unshareable objects can only have their weak reference counts manipulated.
Definition at line 212 of file refcounted.cc.
References nub::ref_counts::release_strong().
| void nub::ref_counted::decr_ref_count_no_delete | ( | ) | const throw () [inherited] |
Decrement the object's reference count, but don't delete it.
Unlike decr_ref_count(), the object will NOT be delete'd if the reference count falls to zero. This operation (on the strong reference count) is not permitted if the object is unshareable. Unshareable objects can only have their weak reference counts manipulated.
Definition at line 221 of file refcounted.cc.
References nub::ref_counts::release_strong_no_delete().
| bool nub::ref_counted::is_shared | ( | ) | const throw () [inherited] |
Returns true if no external client has sole ownership of the object.
This may occur if either (1) the reference count is greater than one, or (2) the object is_not_shareable(), meaning that the object itself is the only "owner".
Definition at line 226 of file refcounted.cc.
References rutz::mutex_atomic_int::atomic_get(), nub::ref_counted::is_not_shareable(), and nub::ref_counts::m_strong.
Referenced by nub::ref_counted::is_unshared().
| bool nub::ref_counted::is_unshared | ( | ) | const throw () [inherited] |
Returns true if there is a sole external owner of the object.
This occurs if the reference count is one or less and the object is shareable.
Definition at line 236 of file refcounted.cc.
References nub::ref_counted::is_shared().
| bool nub::ref_counted::is_not_shareable | ( | ) | const throw () [inherited] |
Returns true if the object is not shareable for any reason. This could be because its lifespan is volatile (such as objects representing on-screen windows that can be dismissed by the user). The default is for objects to be shareable; objects can declare themselves as unshareable by calling mark_as_volatile().
Definition at line 242 of file refcounted.cc.
References nub::ref_counts::m_volatile.
Referenced by nub::ref_counted::is_shared().
The documentation for this class was generated from the following files:
- src/gfx/gxseparator.h
- src/gfx/gxseparator.cc