openscenegraph
Public Types | Public Member Functions | Protected Member Functions | List of all members
osgWidget::Box Class Reference
Inheritance diagram for osgWidget::Box:
osgWidget::Window osg::MatrixTransform osgWidget::UIObjectParent< Widget > osgWidget::EventInterface osgWidget::StyleInterface osg::Transform osg::Group osg::Node osg::Object osg::Referenced

Public Types

enum  BoxType { VERTICAL, HORIZONTAL }
 An enum corresponding to the type of Box alignment. More...
- Public Types inherited from osgWidget::Window
enum  Strata { STRATA_NONE, STRATA_BACKGROUND, STRATA_FOREGROUND }
enum  VisibilityMode { VM_FULL, VM_PARTIAL, VM_ENTIRE }
enum  VerticalAnchor { VA_NONE, VA_CENTER, VA_TOP, VA_BOTTOM }
enum  HorizontalAnchor { HA_NONE, HA_CENTER, HA_LEFT, HA_RIGHT }
typedef std::list
< osg::observer_ptr< Window > > 
WindowList
typedef point_type(Widget::* Getter )() const
- Public Types inherited from osgWidget::UIObjectParent< Widget >
typedef Widget object_type
typedef osg::observer_ptr
< object_type
ptr_type
typedef std::vector< ptr_typeVector
typedef Vector::iterator Iterator
typedef Vector::const_iterator ConstIterator

Public Member Functions

 META_Object (osgWidget, Box)
 Box (const std::string &="", BoxType=HORIZONTAL, bool=false)
 Box (const Box &, const osg::CopyOp &)
- Public Member Functions inherited from osgWidget::Window
 Window (const std::string &="")
 Window (const Window &, const osg::CopyOp &)
bool resize (point_type=0.0f, point_type=0.0f)
bool resizeAdd (point_type=0.0f, point_type=0.0f)
bool resizePercent (point_type=0.0f, point_type=0.0f)
virtual void update ()
virtual void managed (WindowManager *)
virtual void unmanaged (WindowManager *)
virtual bool addWidget (Widget *)
virtual bool insertWidget (Widget *, unsigned int)
virtual bool removeWidget (Widget *)
virtual bool replaceWidget (Widget *, Widget *)
unsigned int addDrawableAndGetIndex (osg::Drawable *)
unsigned int addChildAndGetIndex (osg::Node *)
bool isVisible () const
bool isXYWithinVisible (float, float) const
void setVisibleArea (int=0, int=0, int=0, int=0)
void addVisibleArea (int=0, int=0, int=0, int=0)
bool setFocused (const Widget *)
bool setFocused (const std::string &)
bool grabFocus ()
bool setFirstFocusable ()
bool setNextFocusable ()
bool getFocusList (WidgetList &) const
bool getEmbeddedList (WindowList &) const
void getParentList (WindowList &) const
XYCoord localXY (double, double) const
XYCoord getAbsoluteOrigin () const
EmbeddedWindowembed (const std::string &="", Widget::Layer=Widget::LAYER_MIDDLE, unsigned int=0)
WidgetgetFocused ()
const WidgetgetFocused () const
bool show ()
bool hide ()
bool isPointerXYWithinVisible (float x, float y) const
osg::GeodegetGeode ()
const osg::GeodegetGeode () const
WidgetgetBackground ()
const WidgetgetBackground () const
WindowManagergetWindowManager ()
const WindowManagergetWindowManager () const
WindowgetParent ()
const WindowgetParent () const
WindowgetTopmostParent ()
const WindowgetTopmostParent () const
unsigned int getIndex () const
matrix_type getX () const
matrix_type getY () const
matrix_type getZ () const
point_type getWidth () const
point_type getHeight () const
point_type getMinWidth () const
point_type getMinHeight () const
VerticalAnchor getAnchorVertical () const
HorizontalAnchor getAnchorHorizontal () const
XYCoord getOrigin () const
XYCoord getSize () const
XYCoord getMinSize () const
matrix_type getZRange () const
Strata getStrata () const
const QuadgetVisibleArea () const
VisibilityMode getVisibilityMode () const
Point getPosition () const
matrix_type getRotate () const
matrix_type getScale () const
matrix_type getScaleDenominator () const
void setX (matrix_type x)
void setY (matrix_type y)
void setZ (matrix_type z)
void setZRange (matrix_type zRange)
void setPosition (matrix_type x, matrix_type y, matrix_type z)
void setPosition (const Point &p)
void setOrigin (matrix_type x, matrix_type y)
void setOrigin (const XYCoord &xy)
void setRotate (matrix_type r)
void setScale (matrix_type s)
void setScaleDenominator (matrix_type sd)
void setAnchorVertical (VerticalAnchor va)
void setAnchorHorizontal (HorizontalAnchor ha)
void setStrata (Strata s)
void setVisibilityMode (VisibilityMode v)
void addX (matrix_type x)
void addY (matrix_type y)
void addZ (matrix_type z)
void addRotate (matrix_type r)
void addScale (matrix_type s)
void addOrigin (matrix_type x, matrix_type y)
void attachMoveCallback ()
void attachRotateCallback ()
void attachScaleCallback ()
void attachTabFocusCallback ()
- Public Member Functions inherited from osg::MatrixTransform
 MatrixTransform ()
 MatrixTransform (const MatrixTransform &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 MatrixTransform (const Matrix &matix)
 META_Node (osg, MatrixTransform)
virtual MatrixTransformasMatrixTransform ()
virtual const MatrixTransformasMatrixTransform () const
void setMatrix (const Matrix &mat)
const MatrixgetMatrix () const
void preMult (const Matrix &mat)
void postMult (const Matrix &mat)
const MatrixgetInverseMatrix () const
virtual bool computeLocalToWorldMatrix (Matrix &matrix, NodeVisitor *) const
virtual bool computeWorldToLocalMatrix (Matrix &matrix, NodeVisitor *) const
- Public Member Functions inherited from osg::Transform
 Transform ()
 Transform (const Transform &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 META_Node (osg, Transform)
virtual TransformasTransform ()
virtual const TransformasTransform () const
virtual PositionAttitudeTransformasPositionAttitudeTransform ()
virtual const
PositionAttitudeTransform
asPositionAttitudeTransform () const
void setReferenceFrame (ReferenceFrame rf)
ReferenceFrame getReferenceFrame () const
virtual BoundingSphere computeBound () const
- Public Member Functions inherited from osg::Group
 Group ()
 Group (const Group &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 META_Node (osg, Group)
virtual GroupasGroup ()
virtual const GroupasGroup () const
virtual void traverse (NodeVisitor &nv)
virtual bool addChild (Node *child)
virtual bool insertChild (unsigned int index, Node *child)
bool removeChild (Node *child)
bool removeChild (unsigned int pos, unsigned int numChildrenToRemove=1)
virtual bool removeChildren (unsigned int pos, unsigned int numChildrenToRemove)
virtual bool replaceChild (Node *origChild, Node *newChild)
unsigned int getNumChildren () const
virtual bool setChild (unsigned int i, Node *node)
NodegetChild (unsigned int i)
const NodegetChild (unsigned int i) const
bool containsNode (const Node *node) const
unsigned int getChildIndex (const Node *node) const
virtual void setThreadSafeRefUnref (bool threadSafe)
virtual void resizeGLObjectBuffers (unsigned int maxSize)
virtual void releaseGLObjects (osg::State *=0) const
- Public Member Functions inherited from osg::Node
 Node ()
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual ObjectcloneType () const
virtual Objectclone (const CopyOp &copyop) const
virtual bool isSameKindAs (const Object *obj) const
virtual const char * libraryName () const
virtual const char * className () const
virtual SwitchasSwitch ()
virtual const SwitchasSwitch () const
virtual GeodeasGeode ()
virtual const GeodeasGeode () const
virtual osgTerrain::TerrainasTerrain ()
virtual const osgTerrain::TerrainasTerrain () const
virtual void accept (NodeVisitor &nv)
virtual void ascend (NodeVisitor &nv)
const ParentListgetParents () const
ParentList getParents ()
GroupgetParent (unsigned int i)
const GroupgetParent (unsigned int i) const
unsigned int getNumParents () const
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
void setUpdateCallback (NodeCallback *nc)
NodeCallbackgetUpdateCallback ()
const NodeCallbackgetUpdateCallback () const
void addUpdateCallback (NodeCallback *nc)
void removeUpdateCallback (NodeCallback *nc)
unsigned int getNumChildrenRequiringUpdateTraversal () const
void setEventCallback (NodeCallback *nc)
NodeCallbackgetEventCallback ()
const NodeCallbackgetEventCallback () const
void addEventCallback (NodeCallback *nc)
void removeEventCallback (NodeCallback *nc)
unsigned int getNumChildrenRequiringEventTraversal () const
void setCullCallback (NodeCallback *nc)
NodeCallbackgetCullCallback ()
const NodeCallbackgetCullCallback () const
void addCullCallback (NodeCallback *nc)
void removeCullCallback (NodeCallback *nc)
void setCullingActive (bool active)
bool getCullingActive () const
unsigned int getNumChildrenWithCullingDisabled () const
bool isCullingActive () const
unsigned int getNumChildrenWithOccluderNodes () const
bool containsOccluderNodes () const
void setNodeMask (NodeMask nm)
NodeMask getNodeMask () const
void setStateSet (osg::StateSet *stateset)
osg::StateSetgetOrCreateStateSet ()
osg::StateSetgetStateSet ()
const osg::StateSetgetStateSet () const
void setDescriptions (const DescriptionList &descriptions)
DescriptionListgetDescriptions ()
const DescriptionListgetDescriptions () const
const std::string & getDescription (unsigned int i) const
std::string & getDescription (unsigned int i)
unsigned int getNumDescriptions () const
void addDescription (const std::string &desc)
void setInitialBound (const osg::BoundingSphere &bsphere)
const BoundingSpheregetInitialBound () const
void dirtyBound ()
const BoundingSpheregetBound () const
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
const
ComputeBoundingSphereCallback
getComputeBoundingSphereCallback () const
- Public Member Functions inherited from osg::Object
 Object ()
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual void setName (const std::string &name)
void setName (const char *name)
const std::string & getName () const
void setDataVariance (DataVariance dv)
DataVariance getDataVariance () const
virtual void computeDataVariance ()
void setUserDataContainer (osg::UserDataContainer *udc)
osg::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
virtual ReferencedgetUserData ()
virtual const ReferencedgetUserData () const
template<typename T >
bool getUserValue (const std::string &name, T &value) const
template<typename T >
void setUserValue (const std::string &name, const T &value)
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
OpenThreads::MutexgetRefMutex () const
int ref () const
int unref () const
int unref_nodelete () const
int referenceCount () const
ObserverSetgetObserverSet () const
ObserverSetgetOrCreateObserverSet () const
void addObserver (Observer *observer) const
void removeObserver (Observer *observer) const
- Public Member Functions inherited from osgWidget::UIObjectParent< Widget >
Iterator begin ()
ConstIterator begin () const
Iterator end ()
ConstIterator end () const
Vector::size_type size () const
object_typegetByName (const std::string &name)
const object_typegetByName (const std::string &name) const
object_typegetByIndex (unsigned int index)
const object_typegetByIndex (unsigned int index) const
unsigned int getNumObjects () const
VectorgetObjects ()
const VectorgetObjects () const
- Public Member Functions inherited from osgWidget::EventInterface
 EventInterface ()
 EventInterface (const EventInterface &ei)
virtual ~EventInterface ()
virtual bool focus (const WindowManager *)
virtual bool unfocus (const WindowManager *)
virtual bool mouseEnter (double, double, const WindowManager *)
virtual bool mouseOver (double, double, const WindowManager *)
virtual bool mouseLeave (double, double, const WindowManager *)
virtual bool mouseDrag (double, double, const WindowManager *)
virtual bool mousePush (double, double, const WindowManager *)
virtual bool mouseRelease (double, double, const WindowManager *)
virtual bool mouseScroll (double, double, const WindowManager *)
virtual bool keyDown (int, int, const WindowManager *)
virtual bool keyUp (int, int, const WindowManager *)
void setEventMask (unsigned int mask)
void addEventMask (unsigned int mask)
void removeEventMask (unsigned int mask)
unsigned int getEventMask () const
void addCallback (Callback *cb)
bool callCallbacks (Event &ev)
bool callMethodAndCallbacks (Event &ev)
bool canFocus () const
bool canUnfocus () const
bool canMouseEnter () const
bool canMouseOver () const
bool canMouseLeave () const
bool canMouseDrag () const
bool canMousePush () const
bool canMouseRelease () const
bool canMouseScroll () const
bool canKeyDown () const
bool canKeyUp () const
- Public Member Functions inherited from osgWidget::StyleInterface
 StyleInterface ()
 StyleInterface (const StyleInterface &si)
void setStyle (const std::string &style)
std::string & getStyle ()
const std::string & getStyle () const

Protected Member Functions

virtual void _resizeImplementation (point_type, point_type)
virtual Sizes _getWidthImplementation () const
virtual Sizes _getHeightImplementation () const
- Protected Member Functions inherited from osgWidget::Window
template<typename T >
point_type _forEachAssignOrApply (Getter get, int begin, int end, int add, bool assign) const
void _setWidthAndHeightUnknownSizeError (const std::string &, point_type)
void _setWidthAndHeightNotPAError (const std::string &, point_type)
void _setWidthAndHeight ()
void _removeFromGeode (Widget *)
Widget_getBackground () const
Window_getTopmostParent () const
template<typename T >
point_type _compare (Getter get, int begin=0, int end=0, int add=1) const
template<typename T >
point_type _accumulate (Getter get, int begin=0, int end=0, int add=1) const
osg::Geode_geode ()
const osg::Geode_geode () const
Widget_bg ()
const Widget_bg () const
osg::Scissor_scissor ()
bool _setWidget (Widget *, int=-1)
bool _setVisible (bool)
void _setFocused (Widget *)
void _setStyled (Widget *)
void _setParented (Widget *, bool=false)
void _setManaged (Widget *, bool=false)
void _positionWidget (Widget *, point_type, point_type)
point_type _getMinWidgetWidth (int=0, int=0, int=1) const
point_type _getMinWidgetHeight (int=0, int=0, int=1) const
point_type _getMaxWidgetWidth (int=0, int=0, int=1) const
point_type _getMaxWidgetHeight (int=0, int=0, int=1) const
point_type _getMinWidgetMinWidth (int=0, int=0, int=1) const
point_type _getMinWidgetMinHeight (int=0, int=0, int=1) const
point_type _getMaxWidgetMinWidth (int=0, int=0, int=1) const
point_type _getMaxWidgetMinHeight (int=0, int=0, int=1) const
point_type _getMinWidgetWidthTotal (int=0, int=0, int=1) const
point_type _getMinWidgetHeightTotal (int=0, int=0, int=1) const
point_type _getMaxWidgetWidthTotal (int=0, int=0, int=1) const
point_type _getMaxWidgetHeightTotal (int=0, int=0, int=1) const
point_type _getMinWidgetMinWidthTotal (int=0, int=0, int=1) const
point_type _getMinWidgetMinHeightTotal (int=0, int=0, int=1) const
point_type _getMaxWidgetMinWidthTotal (int=0, int=0, int=1) const
point_type _getMaxWidgetMinHeightTotal (int=0, int=0, int=1) const
point_type _getMinWidgetPadHorizontal (int=0, int=0, int=1) const
point_type _getMinWidgetPadVertical (int=0, int=0, int=1) const
point_type _getMaxWidgetPadHorizontal (int=0, int=0, int=1) const
point_type _getMaxWidgetPadVertical (int=0, int=0, int=1) const
point_type _getNumFill (int=0, int=0, int=1) const
- Protected Member Functions inherited from osg::MatrixTransform
virtual ~MatrixTransform ()
- Protected Member Functions inherited from osg::Transform
virtual ~Transform ()
- Protected Member Functions inherited from osg::Group
virtual ~Group ()
virtual void childRemoved (unsigned int, unsigned int)
virtual void childInserted (unsigned int)
- Protected Member Functions inherited from osg::Node
virtual ~Node ()
void addParent (osg::Group *node)
void removeParent (osg::Group *node)
void setNumChildrenRequiringUpdateTraversal (unsigned int num)
void setNumChildrenRequiringEventTraversal (unsigned int num)
void setNumChildrenWithCullingDisabled (unsigned int num)
void setNumChildrenWithOccluderNodes (unsigned int num)
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
void deleteUsingDeleteHandler () const
- Protected Member Functions inherited from osgWidget::UIObjectParent< Widget >
bool _remove (object_type *obj)
bool _removeByName (const std::string &name)

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool getThreadSafeReferenceCounting ()
static void setDeleteHandler (DeleteHandler *handler)
static DeleteHandlergetDeleteHandler ()
- Protected Types inherited from osgWidget::Window
typedef std::less< point_typeLess
typedef std::greater< point_typeGreater
typedef std::plus< point_typePlus
- Protected Attributes inherited from osgWidget::Window
Window_parent
WindowManager_wm
unsigned int _index
matrix_type _x
matrix_type _y
matrix_type _z
matrix_type _zRange
Strata _strata
VisibilityMode _vis
matrix_type _r
matrix_type _s
matrix_type _scaleDenom
Sizes _width
Sizes _height
VerticalAnchor _vAnchor
HorizontalAnchor _hAnchor
osg::observer_ptr< Widget_focused
Quad _visibleArea

Detailed Description

The Box object is a Window subclass that can be configured to uniformly (or non-uniformly) position it's children either vertically or horizontally. It is the most basic Window implementation, though there is some difficulty when positioning children such that each child object ends up pixel-aligned.

Member Enumeration Documentation

An enum corresponding to the type of Box alignment.

Enumerator:
VERTICAL 
HORIZONTAL 

Constructor & Destructor Documentation

osgWidget::Box::Box ( const std::string &  = "",
BoxType  = HORIZONTAL,
bool  = false 
)

The main constructor; takes the string name, the BoxType orientation, and a boolean indicating whether or not all of the Box regions should be uniformly sized.

osgWidget::Box::Box ( const Box ,
const osg::CopyOp  
)

Member Function Documentation

virtual Sizes osgWidget::Box::_getHeightImplementation ( ) const
protectedvirtual

Reimplemented from osgWidget::Window.

virtual Sizes osgWidget::Box::_getWidthImplementation ( ) const
protectedvirtual

Reimplemented from osgWidget::Window.

virtual void osgWidget::Box::_resizeImplementation ( point_type  ,
point_type   
)
protectedvirtual

Implements osgWidget::Window.

osgWidget::Box::META_Object ( osgWidget  ,
Box   
)

The documentation for this class was generated from the following file: