OpenSceneGraph
Public Types | Public Member Functions | Protected Attributes | List of all members
osgViewer::GraphicsWindow Class Reference

Base class for providing Windowing API agnostic access to creating and managing graphics window and events. More...

Inheritance diagram for osgViewer::GraphicsWindow:
Inheritance graph
[legend]

Public Types

enum  MouseCursor {
  InheritCursor, NoCursor, RightArrowCursor, LeftArrowCursor,
  InfoCursor, DestroyCursor, HelpCursor, CycleCursor,
  SprayCursor, WaitCursor, TextCursor, CrosshairCursor,
  HandCursor, UpDownCursor, LeftRightCursor, TopSideCursor,
  BottomSideCursor, LeftSideCursor, RightSideCursor, TopLeftCorner,
  TopRightCorner, BottomRightCorner, BottomLeftCorner
}
 Mouse cursor types, the same ones already present with ancient glut ... More...
 
typedef std::list< osgViewer::View * > Views
 
- Public Types inherited from osg::GraphicsContext
typedef std::vector< ScreenSettingsScreenSettingsList
 
typedef std::vector< GraphicsContext * > GraphicsContexts
 
typedef std::list< ref_ptr< Operation > > GraphicsOperationQueue
 
typedef std::list< osg::Camera *> Cameras
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 

Public Member Functions

 GraphicsWindow ()
 
virtual bool isSameKindAs (const Object *object) const
 
virtual const char * libraryName () const
 return the name of the object's library. More...
 
virtual const char * className () const
 return the name of the object's class type. More...
 
void setEventQueue (osgGA::EventQueue *eventQueue)
 
osgGA::EventQueuegetEventQueue ()
 
const osgGA::EventQueuegetEventQueue () const
 
virtual bool checkEvents ()
 Check events, return true if events have been received. More...
 
void setWindowRectangle (int x, int y, int width, int height)
 Set the window's position and size. More...
 
virtual bool setWindowRectangleImplementation (int, int, int, int)
 implementation of setWindowRectangle, should be implemented by derived classes More...
 
virtual void getWindowRectangle (int &x, int &y, int &width, int &height)
 Get the window's position and size. More...
 
void setWindowDecoration (bool flag)
 Set Window decoration. More...
 
virtual bool setWindowDecorationImplementation (bool)
 implementation of setWindowDecoration, should be implemented by derived classes More...
 
virtual bool getWindowDecoration () const
 Set Window decoration. More...
 
virtual void grabFocus ()
 Get focus. More...
 
virtual void grabFocusIfPointerInWindow ()
 Get focus on if the pointer is in this window. More...
 
virtual void raiseWindow ()
 Raise the window to the top. More...
 
virtual void setWindowName (const std::string &)
 Set the name of the window. More...
 
virtual std::string getWindowName ()
 Return the name of the window. More...
 
virtual void useCursor (bool cursorOn)
 Switch on/off the cursor. More...
 
virtual void setCursor (MouseCursor)
 Set mouse cursor to a specific shape. More...
 
virtual void setSyncToVBlank (bool on)
 Create a new mouse cursor from the usual bitmap data. More...
 
bool getSyncToVBlank () const
 
virtual void setSwapGroup (bool on, GLuint group, GLuint barrier)
 Set swap group. More...
 
void getSwapGroup (bool &on, GLuint &group, GLuint &barrier) const
 
virtual bool valid () const
 Return whether a valid and usable GraphicsContext has been created. More...
 
virtual bool realizeImplementation ()
 Realize the GraphicsContext implementation, Pure virtual - must be implemented by concrete implementations of GraphicsContext. More...
 
virtual bool isRealizedImplementation () const
 Return true if the graphics context has been realized, and is ready to use, implementation. More...
 
virtual void closeImplementation ()
 Close the graphics context implementation. More...
 
virtual bool makeCurrentImplementation ()
 Make this graphics context current implementation. More...
 
virtual bool makeContextCurrentImplementation (GraphicsContext *)
 Make this graphics context current with specified read context implementation. More...
 
virtual bool releaseContextImplementation ()
 Release the graphics context. More...
 
virtual void bindPBufferToTextureImplementation (GLenum)
 Pure virtual, Bind the graphics context to associated texture implementation. More...
 
virtual void swapBuffersImplementation ()
 Swap the front and back buffers implementation. More...
 
void getViews (Views &views)
 Returns the list of views (osgViewer::View) attached to this GraphicsWindow. More...
 
virtual void requestRedraw ()
 requestRedraw() requests a single redraw. More...
 
virtual void requestContinuousUpdate (bool=true)
 requestContinuousUpdate(bool) is for en/disabling a throw or idle callback to be requested by a GUIEventHandler (typically a CameraManipulator, though other GUIEventHandler's may also provide functionality). More...
 
virtual void requestWarpPointer (float, float)
 requestWarpPointer(int,int) is requesting a repositioning of the mouse pointer to a specified x,y location on the window. More...
 
- Public Member Functions inherited from osg::GraphicsContext
void add (Operation *operation)
 Add operation to end of OperationQueue. More...
 
void remove (Operation *operation)
 Remove operation from OperationQueue. More...
 
void remove (const std::string &name)
 Remove named operation from OperationQueue. More...
 
void removeAllOperations ()
 Remove all operations from OperationQueue. More...
 
virtual void runOperations ()
 Run the operations. More...
 
GraphicsOperationQueuegetOperationsQueue ()
 Get the operations queue, note you must use the OperationsMutex when accessing the queue. More...
 
OpenThreads::MutexgetOperationsMutex ()
 Get the operations queue mutex. More...
 
osg::RefBlockgetOperationsBlock ()
 Get the operations queue block used to mark an empty queue, if you end items into the empty queue you must release this block. More...
 
OperationgetCurrentOperation ()
 Get the current operations that is being run. More...
 
const TraitsgetTraits () const
 Get the traits of the GraphicsContext. More...
 
void setState (State *state)
 Set the State object which tracks the current OpenGL state for this graphics context. More...
 
StategetState ()
 Get the State object which tracks the current OpenGL state for this graphics context. More...
 
const StategetState () const
 Get the const State object which tracks the current OpenGL state for this graphics context. More...
 
void setClearColor (const Vec4 &color)
 Sets the clear color. More...
 
const Vec4getClearColor () const
 Returns the clear color. More...
 
void setClearMask (GLbitfield mask)
 Set the clear mask used in glClear(..). More...
 
GLbitfield getClearMask () const
 Get the clear mask. More...
 
virtual void clear ()
 Do an OpenGL clear of the full graphics context/window. More...
 
double getTimeSinceLastClear () const
 
bool realize ()
 Realize the GraphicsContext. More...
 
void close (bool callCloseImplementation=true)
 close the graphics context. More...
 
void swapBuffers ()
 swap the front and back buffers. More...
 
bool isRealized () const
 Return true if the graphics context has been realized and is ready to use. More...
 
bool makeCurrent ()
 Make this graphics context current. More...
 
bool makeContextCurrent (GraphicsContext *readContext)
 Make this graphics context current with specified read context. More...
 
bool releaseContext ()
 Release the graphics context. More...
 
bool isCurrent () const
 Return true if the current thread has this OpenGL graphics context. More...
 
void bindPBufferToTexture (GLenum buffer)
 Bind the graphics context to associated texture. More...
 
void createGraphicsThread ()
 Create a graphics thread to the graphics context, so that the thread handles all OpenGL operations. More...
 
void setGraphicsThread (GraphicsThread *gt)
 Assign a graphics thread to the graphics context, so that the thread handles all OpenGL operations. More...
 
GraphicsThreadgetGraphicsThread ()
 Get the graphics thread assigned the graphics context. More...
 
const GraphicsThreadgetGraphicsThread () const
 Get the const graphics thread assigned the graphics context. More...
 
virtual bool makeContextCurrentImplementation (GraphicsContext *readContext)=0
 Make this graphics context current with specified read context implementation. More...
 
void setSwapCallback (SwapCallback *rc)
 Set the swap callback which overrides the GraphicsContext::swapBuffersImplementation(), allowing developers to provide custom behavior for swap. More...
 
SwapCallbackgetSwapCallback ()
 Get the swap callback which overrides the GraphicsContext::swapBuffersImplementation(). More...
 
const SwapCallbackgetSwapCallback () const
 Get the const swap callback which overrides the GraphicsContext::swapBuffersImplementation(). More...
 
void swapBuffersCallbackOrImplementation ()
 Convenience method for handling whether to call swapbuffers callback or the standard context swapBuffersImplementation. More...
 
void resized (int x, int y, int width, int height)
 resized method should be called when the underlying window has been resized and the GraphicsWindow and associated Cameras must be updated to keep in sync with the new size. More...
 
void setResizedCallback (ResizedCallback *rc)
 Set the resized callback which overrides the GraphicsConext::realizedImplementation(), allow developers to provide custom behavior in response to a window being resized. More...
 
ResizedCallbackgetResizedCallback ()
 Get the resized callback which overrides the GraphicsConext::realizedImplementation(). More...
 
const ResizedCallbackgetResizedCallback () const
 Get the const resized callback which overrides the GraphicsConext::realizedImplementation(). More...
 
virtual void resizedImplementation (int x, int y, int width, int height)
 resized implementation, by default resizes the viewports and aspect ratios the cameras associated with the graphics Window. More...
 
CamerasgetCameras ()
 Get the list of cameras associated with this graphics context. More...
 
const CamerasgetCameras () const
 Get the const list of cameras associated with this graphics context. More...
 
void setDefaultFboId (GLuint i)
 set the default FBO-id, this id will be used when the rendering-backend is finished with RTT FBOs More...
 
GLuint getDefaultFboId () const
 
virtual bool isSameKindAs (const Object *object) const
 
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object. More...
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...
 
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name. More...
 
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
 
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
 
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual StateSetasStateSet ()
 Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual const StateSetasStateSet () const
 convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0. More...
 
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual Uniform * asUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const UniformBaseasUniformBase () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual UniformBaseasUniformBase ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const Uniform * asUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual CameraasCamera ()
 Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual const CameraasCamera () const
 convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0. More...
 
virtual DrawableasDrawable ()
 Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0. More...
 
virtual const DrawableasDrawable () const
 convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0. More...
 
virtual CallbackasCallback ()
 Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual const CallbackasCallback () const
 convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0. More...
 
virtual CallbackObjectasCallbackObject ()
 Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual const CallbackObjectasCallbackObject () const
 convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...
 
virtual UserDataContainerasUserDataContainer ()
 Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual const UserDataContainerasUserDataContainer () const
 convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...
 
virtual ValueObjectasValueObject ()
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual const ValueObjectasValueObject () const
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...
 
virtual ImageasImage ()
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
 
virtual const ImageasImage () const
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
virtual void setName (const std::string &name)
 Set the name of object using C++ style string. More...
 
void setName (const char *name)
 Set the name of object using a C style string. More...
 
const std::string & getName () const
 Get the name of object. More...
 
void setDataVariance (DataVariance dv)
 Set the data variance of this object. More...
 
DataVariance getDataVariance () const
 Get the data variance of this object. More...
 
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc. More...
 
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object. More...
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...
 
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () const
 Get const user data. More...
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...
 
virtual void resizeGLObjectBuffers (unsigned int)
 Resize any per context GLObject buffers to specified size. More...
 
virtual void releaseGLObjects (osg::State *=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 provide implementation of osg::Object::getUserValue(..) template More...
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. More...
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::MutexgetRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 
- Public Member Functions inherited from osgGA::GUIActionAdapter
virtual ~GUIActionAdapter ()
 
virtual osg::ViewasView ()
 Provide a mechanism for getting the osg::View associated with this GUIActionAdapter. More...
 
virtual bool computeIntersections (const osgGA::GUIEventAdapter &, osgUtil::LineSegmentIntersector::Intersections &, osg::Node::NodeMask=0xffffffff)
 Compute intersections of a ray, starting the current mouse position, through the specified camera. More...
 
virtual bool computeIntersections (const osgGA::GUIEventAdapter &, const osg::NodePath &, osgUtil::LineSegmentIntersector::Intersections &, osg::Node::NodeMask=0xffffffff)
 Compute intersections of a ray, starting the current mouse position, through the specified master camera's window/eye coordinates and a specified nodePath's subgraph. More...
 

Protected Attributes

osg::ref_ptr< osgGA::EventQueue_eventQueue
 
- Protected Attributes inherited from osg::GraphicsContext
Cameras _cameras
 
ref_ptr< Traits_traits
 
ref_ptr< State_state
 
Vec4 _clearColor
 
GLbitfield _clearMask
 
size_t _threadOfLastMakeCurrent
 
OpenThreads::Mutex _operationsMutex
 
osg::ref_ptr< osg::RefBlock_operationsBlock
 
GraphicsOperationQueue _operations
 
osg::ref_ptr< Operation_currentOperation
 
ref_ptr< GraphicsThread_graphicsThread
 
ref_ptr< ResizedCallback_resizedCallback
 
ref_ptr< SwapCallback_swapCallback
 
Timer_t _lastClearTick
 
GLuint _defaultFboId
 
- Protected Attributes inherited from osg::Object
std::string _name
 
DataVariance _dataVariance
 
osg::UserDataContainer_userDataContainer
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Additional Inherited Members

- Static Public Member Functions inherited from osg::GraphicsContext
static osg::ref_ptr< WindowingSystemInterfaces > & getWindowingSystemInterfaces ()
 
static WindowingSystemInterfacegetWindowingSystemInterface (const std::string &name="")
 Get the default WindowingSystemInterface for this OS. More...
 
static GraphicsContextcreateGraphicsContext (Traits *traits)
 Create a graphics context for a specified set of traits. More...
 
static unsigned int createNewContextID ()
 Create a contextID for a new graphics context, this contextID is used to set up the osg::State associate with context. More...
 
static unsigned int getMaxContextID ()
 Get the current max ContextID. More...
 
static void incrementContextIDUsageCount (unsigned int contextID)
 Increment the usage count associate with a contextID. More...
 
static void decrementContextIDUsageCount (unsigned int contextID)
 Decrement the usage count associate with a contextID. More...
 
static GraphicsContexts getAllRegisteredGraphicsContexts ()
 Get all the registered graphics contexts. More...
 
static GraphicsContexts getRegisteredGraphicsContexts (unsigned int contextID)
 Get all the registered graphics contexts associated with a specific contextID. More...
 
static void setCompileContext (unsigned int contextID, GraphicsContext *gc)
 Get the GraphicsContext for doing background compilation for GraphicsContexts associated with specified contextID. More...
 
static GraphicsContextgetOrCreateCompileContext (unsigned int contextID)
 Get existing or create a new GraphicsContext to do background compilation for GraphicsContexts associated with specified contextID. More...
 
static GraphicsContextgetCompileContext (unsigned int contextID)
 Get the GraphicsContext for doing background compilation for GraphicsContexts associated with specified contextID. More...
 
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 
- Protected Member Functions inherited from osg::GraphicsContext
 GraphicsContext ()
 
 GraphicsContext (const GraphicsContext &, const osg::CopyOp &)
 
virtual ~GraphicsContext ()
 
virtual ObjectcloneType () const
 Clone the type of an object, with Object* return type. More...
 
virtual Objectclone (const CopyOp &) const
 Clone an object, with Object* return type. More...
 
void addCamera (osg::Camera *camera)
 
void removeCamera (osg::Camera *camera)
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 Object destructor. More...
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 
- Static Protected Member Functions inherited from osg::GraphicsContext
static void registerGraphicsContext (GraphicsContext *gc)
 Register a GraphicsContext. More...
 
static void unregisterGraphicsContext (GraphicsContext *gc)
 Unregister a GraphicsContext. More...
 

Detailed Description

Base class for providing Windowing API agnostic access to creating and managing graphics window and events.

Note, the GraphicsWindow is subclassed from osg::GraphicsContext, and to provide an implementation you'll need to implement its range of pure virtual functions, you'll find these all have naming convention methodNameImplementation(..). GraphicsWindow adds the event queue on top of the GraphicsContext, thereby adding a mechanism for adapting Windowing events as well as basics graphics context work, you should wire up custom GraphicsWindowImplementation to push their events through into the EventQueue.

Member Typedef Documentation

◆ Views

Member Enumeration Documentation

◆ MouseCursor

Mouse cursor types, the same ones already present with ancient glut ...

Enumerator
InheritCursor 
NoCursor 
RightArrowCursor 
LeftArrowCursor 
InfoCursor 
DestroyCursor 
HelpCursor 
CycleCursor 
SprayCursor 
WaitCursor 
TextCursor 
CrosshairCursor 
HandCursor 
UpDownCursor 
LeftRightCursor 
TopSideCursor 
BottomSideCursor 
LeftSideCursor 
RightSideCursor 
TopLeftCorner 
TopRightCorner 
BottomRightCorner 
BottomLeftCorner 

Constructor & Destructor Documentation

◆ GraphicsWindow()

osgViewer::GraphicsWindow::GraphicsWindow ( )
inline

Member Function Documentation

◆ bindPBufferToTextureImplementation()

virtual void osgViewer::GraphicsWindow::bindPBufferToTextureImplementation ( GLenum  )
inlinevirtual

Pure virtual, Bind the graphics context to associated texture implementation.

Pure virtual - must be implemented by concrete implementations of GraphicsContext.

Implements osg::GraphicsContext.

References osg::NOTICE, and osg::notify().

◆ checkEvents()

virtual bool osgViewer::GraphicsWindow::checkEvents ( )
inlinevirtual

Check events, return true if events have been received.

Reimplemented in osgViewer::GraphicsWindowX11, and osgViewer::GraphicsWindowWin32.

◆ className()

virtual const char* osgViewer::GraphicsWindow::className ( ) const
inlinevirtual

return the name of the object's class type.

Must be defined by derived classes.

Reimplemented from osg::GraphicsContext.

Reimplemented in osgViewer::GraphicsWindowEmbedded, osgViewer::GraphicsWindowX11, and osgViewer::GraphicsWindowWin32.

◆ closeImplementation()

virtual void osgViewer::GraphicsWindow::closeImplementation ( )
inlinevirtual

Close the graphics context implementation.

Pure virtual - must be implemented by concrete implementations of GraphicsContext.

Implements osg::GraphicsContext.

Reimplemented in osgViewer::GraphicsWindowEmbedded, osgViewer::GraphicsWindowX11, and osgViewer::GraphicsWindowWin32.

References osg::NOTICE, and osg::notify().

◆ getEventQueue() [1/2]

osgGA::EventQueue* osgViewer::GraphicsWindow::getEventQueue ( )
inline

◆ getEventQueue() [2/2]

const osgGA::EventQueue* osgViewer::GraphicsWindow::getEventQueue ( ) const
inline

◆ getSwapGroup()

void osgViewer::GraphicsWindow::getSwapGroup ( bool &  on,
GLuint &  group,
GLuint &  barrier 
) const
inline

◆ getSyncToVBlank()

bool osgViewer::GraphicsWindow::getSyncToVBlank ( ) const
inline

◆ getViews()

void osgViewer::GraphicsWindow::getViews ( Views views)

Returns the list of views (osgViewer::View) attached to this GraphicsWindow.

Internally, the method walks through all the cameras and collects all the views attached to the cameras.

◆ getWindowDecoration()

virtual bool osgViewer::GraphicsWindow::getWindowDecoration ( ) const
inlinevirtual

Set Window decoration.

◆ getWindowName()

virtual std::string osgViewer::GraphicsWindow::getWindowName ( )
inlinevirtual

Return the name of the window.

◆ getWindowRectangle()

virtual void osgViewer::GraphicsWindow::getWindowRectangle ( int &  x,
int &  y,
int &  width,
int &  height 
)
inlinevirtual

Get the window's position and size.

◆ grabFocus()

virtual void osgViewer::GraphicsWindow::grabFocus ( )
inlinevirtual

◆ grabFocusIfPointerInWindow()

virtual void osgViewer::GraphicsWindow::grabFocusIfPointerInWindow ( )
inlinevirtual

Get focus on if the pointer is in this window.

Reimplemented in osgViewer::GraphicsWindowEmbedded, osgViewer::GraphicsWindowX11, and osgViewer::GraphicsWindowWin32.

References osg::NOTICE, and osg::notify().

◆ isRealizedImplementation()

virtual bool osgViewer::GraphicsWindow::isRealizedImplementation ( ) const
inlinevirtual

Return true if the graphics context has been realized, and is ready to use, implementation.

Pure virtual - must be implemented by concrete implementations of GraphicsContext.

Implements osg::GraphicsContext.

Reimplemented in osgViewer::GraphicsWindowEmbedded, osgViewer::GraphicsWindowX11, and osgViewer::GraphicsWindowWin32.

References osg::NOTICE, and osg::notify().

◆ isSameKindAs()

virtual bool osgViewer::GraphicsWindow::isSameKindAs ( const Object object) const
inlinevirtual

◆ libraryName()

virtual const char* osgViewer::GraphicsWindow::libraryName ( ) const
inlinevirtual

return the name of the object's library.

Must be defined by derived classes. The OpenSceneGraph convention is that the namespace of a library is the same as the library name.

Reimplemented from osg::GraphicsContext.

Reimplemented in osgViewer::GraphicsWindowEmbedded, osgViewer::GraphicsWindowX11, and osgViewer::GraphicsWindowWin32.

◆ makeContextCurrentImplementation()

virtual bool osgViewer::GraphicsWindow::makeContextCurrentImplementation ( GraphicsContext )
inlinevirtual

Make this graphics context current with specified read context implementation.

Pure virtual - must be implemented by concrete implementations of GraphicsContext.

References osg::NOTICE, and osg::notify().

◆ makeCurrentImplementation()

virtual bool osgViewer::GraphicsWindow::makeCurrentImplementation ( )
inlinevirtual

Make this graphics context current implementation.

Pure virtual - must be implemented by concrete implementations of GraphicsContext.

Implements osg::GraphicsContext.

Reimplemented in osgViewer::GraphicsWindowEmbedded, osgViewer::GraphicsWindowX11, and osgViewer::GraphicsWindowWin32.

References osg::NOTICE, and osg::notify().

◆ raiseWindow()

virtual void osgViewer::GraphicsWindow::raiseWindow ( )
inlinevirtual

◆ realizeImplementation()

virtual bool osgViewer::GraphicsWindow::realizeImplementation ( )
inlinevirtual

Realize the GraphicsContext implementation, Pure virtual - must be implemented by concrete implementations of GraphicsContext.

Implements osg::GraphicsContext.

Reimplemented in osgViewer::GraphicsWindowEmbedded, osgViewer::GraphicsWindowX11, and osgViewer::GraphicsWindowWin32.

References osg::NOTICE, and osg::notify().

◆ releaseContextImplementation()

virtual bool osgViewer::GraphicsWindow::releaseContextImplementation ( )
inlinevirtual

Release the graphics context.

Implements osg::GraphicsContext.

Reimplemented in osgViewer::GraphicsWindowEmbedded, osgViewer::GraphicsWindowX11, and osgViewer::GraphicsWindowWin32.

References osg::NOTICE, and osg::notify().

◆ requestContinuousUpdate()

virtual void osgViewer::GraphicsWindow::requestContinuousUpdate ( bool  needed = true)
inlinevirtual

requestContinuousUpdate(bool) is for en/disabling a throw or idle callback to be requested by a GUIEventHandler (typically a CameraManipulator, though other GUIEventHandler's may also provide functionality).

GUI toolkits can respond to this immediately by registering an idle/timed callback, or can delay setting the callback and update at their own leisure.

Implements osgGA::GUIActionAdapter.

◆ requestRedraw()

virtual void osgViewer::GraphicsWindow::requestRedraw ( )
virtual

requestRedraw() requests a single redraw.

Implements osgGA::GUIActionAdapter.

◆ requestWarpPointer()

virtual void osgViewer::GraphicsWindow::requestWarpPointer ( float  x,
float  y 
)
inlinevirtual

requestWarpPointer(int,int) is requesting a repositioning of the mouse pointer to a specified x,y location on the window.

This is used by some camera manipulators to initialise the mouse pointer when mouse position relative to a controls neutral mouse position is required, i.e when mimicking an aircraft joystick.

Implements osgGA::GUIActionAdapter.

Reimplemented in osgViewer::GraphicsWindowX11, and osgViewer::GraphicsWindowWin32.

◆ setCursor()

virtual void osgViewer::GraphicsWindow::setCursor ( MouseCursor  )
inlinevirtual

Set mouse cursor to a specific shape.

Reimplemented in osgViewer::GraphicsWindowX11.

References osg::NOTICE, and osg::notify().

◆ setEventQueue()

void osgViewer::GraphicsWindow::setEventQueue ( osgGA::EventQueue eventQueue)
inline

◆ setSwapGroup()

virtual void osgViewer::GraphicsWindow::setSwapGroup ( bool  on,
GLuint  group,
GLuint  barrier 
)
inlinevirtual

Set swap group.

Reimplemented in osgViewer::GraphicsWindowWin32.

References osg::NOTICE, and osg::notify().

◆ setSyncToVBlank()

virtual void osgViewer::GraphicsWindow::setSyncToVBlank ( bool  on)
inlinevirtual

Create a new mouse cursor from the usual bitmap data.

Set sync-to-vblank.

Reimplemented in osgViewer::GraphicsWindowWin32.

References osg::NOTICE, and osg::notify().

◆ setWindowDecoration()

void osgViewer::GraphicsWindow::setWindowDecoration ( bool  flag)
inline

Set Window decoration.

◆ setWindowDecorationImplementation()

virtual bool osgViewer::GraphicsWindow::setWindowDecorationImplementation ( bool  )
inlinevirtual

implementation of setWindowDecoration, should be implemented by derived classes

Reimplemented in osgViewer::GraphicsWindowX11, and osgViewer::GraphicsWindowWin32.

References osg::NOTICE, and osg::notify().

◆ setWindowName()

virtual void osgViewer::GraphicsWindow::setWindowName ( const std::string &  )
inlinevirtual

Set the name of the window.

Reimplemented in osgViewer::GraphicsWindowX11, and osgViewer::GraphicsWindowWin32.

References osg::NOTICE, and osg::notify().

◆ setWindowRectangle()

void osgViewer::GraphicsWindow::setWindowRectangle ( int  x,
int  y,
int  width,
int  height 
)
inline

Set the window's position and size.

◆ setWindowRectangleImplementation()

virtual bool osgViewer::GraphicsWindow::setWindowRectangleImplementation ( int  ,
int  ,
int  ,
int   
)
inlinevirtual

implementation of setWindowRectangle, should be implemented by derived classes

Reimplemented in osgViewer::GraphicsWindowX11, and osgViewer::GraphicsWindowWin32.

References osg::NOTICE, and osg::notify().

◆ swapBuffersImplementation()

virtual void osgViewer::GraphicsWindow::swapBuffersImplementation ( )
inlinevirtual

Swap the front and back buffers implementation.

Pure virtual - must be implemented by concrete implementations of GraphicsContext.

Implements osg::GraphicsContext.

Reimplemented in osgViewer::GraphicsWindowEmbedded, osgViewer::GraphicsWindowX11, and osgViewer::GraphicsWindowWin32.

References osg::NOTICE, and osg::notify().

◆ useCursor()

virtual void osgViewer::GraphicsWindow::useCursor ( bool  cursorOn)
inlinevirtual

Switch on/off the cursor.

Reimplemented in osgViewer::GraphicsWindowWin32.

◆ valid()

virtual bool osgViewer::GraphicsWindow::valid ( ) const
inlinevirtual

Return whether a valid and usable GraphicsContext has been created.

Implements osg::GraphicsContext.

Reimplemented in osgViewer::GraphicsWindowEmbedded, osgViewer::GraphicsWindowX11, and osgViewer::GraphicsWindowWin32.

References osg::NOTICE, and osg::notify().

Member Data Documentation

◆ _eventQueue

osg::ref_ptr<osgGA::EventQueue> osgViewer::GraphicsWindow::_eventQueue
protected

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