openscenegraph
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osgUtil::SceneView Class Reference
Inheritance diagram for osgUtil::SceneView:
osg::Object osg::CullSettings osg::Referenced

Classes

struct  ComputeStereoMatricesCallback

Public Types

enum  Options {
  NO_SCENEVIEW_LIGHT = 0x0, HEADLIGHT = 0x1, SKY_LIGHT = 0x2, COMPILE_GLOBJECTS_AT_INIT = 0x4,
  STANDARD_SETTINGS
}
enum  ActiveUniforms {
  FRAME_NUMBER_UNIFORM = 1, FRAME_TIME_UNIFORM = 2, DELTA_FRAME_TIME_UNIFORM = 4, SIMULATION_TIME_UNIFORM = 8,
  DELTA_SIMULATION_TIME_UNIFORM = 16, VIEW_MATRIX_UNIFORM = 32, VIEW_MATRIX_INVERSE_UNIFORM = 64, DEFAULT_UNIFORMS,
  ALL_UNIFORMS = 0x7FFFFFFF
}
enum  FusionDistanceMode { USE_FUSION_DISTANCE_VALUE, PROPORTIONAL_TO_SCREEN_DISTANCE }
typedef Options LightingMode
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
- Public Types inherited from osg::CullSettings
enum  VariablesMask {
  COMPUTE_NEAR_FAR_MODE = (0x1 << 0), CULLING_MODE = (0x1 << 1), LOD_SCALE = (0x1 << 2), SMALL_FEATURE_CULLING_PIXEL_SIZE = (0x1 << 3),
  CLAMP_PROJECTION_MATRIX_CALLBACK = (0x1 << 4), NEAR_FAR_RATIO = (0x1 << 5), IMPOSTOR_ACTIVE = (0x1 << 6), DEPTH_SORT_IMPOSTOR_SPRITES = (0x1 << 7),
  IMPOSTOR_PIXEL_ERROR_THRESHOLD = (0x1 << 8), NUM_FRAMES_TO_KEEP_IMPOSTORS_SPRITES = (0x1 << 9), CULL_MASK = (0x1 << 10), CULL_MASK_LEFT = (0x1 << 11),
  CULL_MASK_RIGHT = (0x1 << 12), CLEAR_COLOR = (0x1 << 13), CLEAR_MASK = (0x1 << 14), LIGHTING_MODE = (0x1 << 15),
  LIGHT = (0x1 << 16), DRAW_BUFFER = (0x1 << 17), READ_BUFFER = (0x1 << 18), NO_VARIABLES = 0x00000000,
  ALL_VARIABLES = 0x7FFFFFFF
}
enum  InheritanceMaskActionOnAttributeSetting { DISABLE_ASSOCIATED_INHERITANCE_MASK_BIT, DO_NOT_MODIFY_INHERITANCE_MASK }
enum  ComputeNearFarMode { DO_NOT_COMPUTE_NEAR_FAR = 0, COMPUTE_NEAR_FAR_USING_BOUNDING_VOLUMES, COMPUTE_NEAR_FAR_USING_PRIMITIVES }
enum  CullingModeValues {
  NO_CULLING = 0x0, VIEW_FRUSTUM_SIDES_CULLING = 0x1, NEAR_PLANE_CULLING = 0x2, FAR_PLANE_CULLING = 0x4,
  VIEW_FRUSTUM_CULLING, SMALL_FEATURE_CULLING = 0x8, SHADOW_OCCLUSION_CULLING = 0x10, CLUSTER_CULLING = 0x20,
  DEFAULT_CULLING, ENABLE_ALL_CULLING
}
typedef int InheritanceMask
typedef int CullingMode

Public Member Functions

 SceneView (osg::DisplaySettings *ds=NULL)
 SceneView (const SceneView &sceneview, const osg::CopyOp &copyop=osg::CopyOp())
 META_Object (osgUtil, SceneView)
virtual void setDefaults ()
virtual void setDefaults (unsigned int options)
void setCamera (osg::Camera *camera, bool assumeOwnershipOfCamera=true)
osg::Camera * getCamera ()
const osg::Camera * getCamera () const
void setSceneData (osg::Node *node)
osg::Node * getSceneData (unsigned int childNo=0)
const osg::Node * getSceneData (unsigned int childNo=0) const
unsigned int getNumSceneData () const
void setViewport (osg::Viewport *viewport)
void setViewport (int x, int y, int width, int height)
osg::Viewport * getViewport ()
const osg::Viewport * getViewport () const
void setDisplaySettings (osg::DisplaySettings *vs)
const osg::DisplaySettings * getDisplaySettings () const
osg::DisplaySettings * getDisplaySettings ()
void setClearColor (const osg::Vec4 &color)
const osg::Vec4 & getClearColor () const
void setRedrawInterlacedStereoStencilMask (bool flag)
bool getRedrawInterlacedStereoStencilMask () const
void setGlobalStateSet (osg::StateSet *state)
osg::StateSet * getGlobalStateSet ()
const osg::StateSet * getGlobalStateSet () const
void setSecondaryStateSet (osg::StateSet *state)
osg::StateSet * getSecondaryStateSet ()
const osg::StateSet * getSecondaryStateSet () const
void setLocalStateSet (osg::StateSet *state)
osg::StateSet * getLocalStateSet ()
const osg::StateSet * getLocalStateSet () const
void setActiveUniforms (int activeUniforms)
int getActiveUniforms () const
void updateUniforms ()
void setLightingMode (LightingMode mode)
LightingMode getLightingMode () const
void setLight (osg::Light *light)
osg::Light * getLight ()
const osg::Light * getLight () const
void setState (osg::State *state)
osg::State * getState ()
const osg::State * getState () const
void setView (osg::View *view)
osg::View * getView ()
const osg::View * getView () const
void setRenderInfo (osg::RenderInfo &renderInfo)
osg::RenderInfo & getRenderInfo ()
const osg::RenderInfo & getRenderInfo () const
void setProjectionMatrix (const osg::Matrixf &matrix)
void setProjectionMatrix (const osg::Matrixd &matrix)
void setProjectionMatrixAsOrtho (double left, double right, double bottom, double top, double zNear, double zFar)
void setProjectionMatrixAsOrtho2D (double left, double right, double bottom, double top)
void setProjectionMatrixAsFrustum (double left, double right, double bottom, double top, double zNear, double zFar)
void setProjectionMatrixAsPerspective (double fovy, double aspectRatio, double zNear, double zFar)
osg::Matrixd & getProjectionMatrix ()
const osg::Matrixd & getProjectionMatrix () const
bool getProjectionMatrixAsOrtho (double &left, double &right, double &bottom, double &top, double &zNear, double &zFar) const
bool getProjectionMatrixAsFrustum (double &left, double &right, double &bottom, double &top, double &zNear, double &zFar) const
bool getProjectionMatrixAsPerspective (double &fovy, double &aspectRatio, double &zNear, double &zFar) const
void setViewMatrix (const osg::Matrixf &matrix)
void setViewMatrix (const osg::Matrixd &matrix)
void setViewMatrixAsLookAt (const osg::Vec3 &eye, const osg::Vec3 &center, const osg::Vec3 &up)
osg::Matrixd & getViewMatrix ()
const osg::Matrixd & getViewMatrix () const
void getViewMatrixAsLookAt (osg::Vec3 &eye, osg::Vec3 &center, osg::Vec3 &up, float lookDistance=1.0f) const
void setInitVisitor (osg::NodeVisitor *av)
osg::NodeVisitor * getInitVisitor ()
const osg::NodeVisitor * getInitVisitor () const
void setUpdateVisitor (osg::NodeVisitor *av)
osg::NodeVisitor * getUpdateVisitor ()
const osg::NodeVisitor * getUpdateVisitor () const
void setCullVisitor (osgUtil::CullVisitor *cv)
osgUtil::CullVisitor * getCullVisitor ()
const osgUtil::CullVisitor * getCullVisitor () const
void setCullVisitorLeft (osgUtil::CullVisitor *cv)
osgUtil::CullVisitor * getCullVisitorLeft ()
const osgUtil::CullVisitor * getCullVisitorLeft () const
void setCullVisitorRight (osgUtil::CullVisitor *cv)
osgUtil::CullVisitor * getCullVisitorRight ()
const osgUtil::CullVisitor * getCullVisitorRight () const
void setCollectOccludersVisitor (osg::CollectOccludersVisitor *cov)
osg::CollectOccludersVisitor * getCollectOccludersVisitor ()
const
osg::CollectOccludersVisitor * 
getCollectOccludersVisitor () const
void setStateGraph (osgUtil::StateGraph *rg)
osgUtil::StateGraph * getStateGraph ()
const osgUtil::StateGraph * getStateGraph () const
void setStateGraphLeft (osgUtil::StateGraph *rg)
osgUtil::StateGraph * getStateGraphLeft ()
const osgUtil::StateGraph * getStateGraphLeft () const
void setStateGraphRight (osgUtil::StateGraph *rg)
osgUtil::StateGraph * getStateGraphRight ()
const osgUtil::StateGraph * getStateGraphRight () const
void setRenderStage (osgUtil::RenderStage *rs)
osgUtil::RenderStage * getRenderStage ()
const osgUtil::RenderStage * getRenderStage () const
void setRenderStageLeft (osgUtil::RenderStage *rs)
osgUtil::RenderStage * getRenderStageLeft ()
const osgUtil::RenderStage * getRenderStageLeft () const
void setRenderStageRight (osgUtil::RenderStage *rs)
osgUtil::RenderStage * getRenderStageRight ()
const osgUtil::RenderStage * getRenderStageRight () const
void collateReferencesToDependentCameras ()
void clearReferencesToDependentCameras ()
void setDrawBufferValue (GLenum drawBufferValue)
GLenum getDrawBufferValue () const
void setFusionDistance (FusionDistanceMode mode, float value=1.0f)
FusionDistanceMode getFusionDistanceMode () const
float getFusionDistanceValue () const
void setPrioritizeTextures (bool pt)
bool getPrioritizeTextures () const
void setComputeStereoMatricesCallback (ComputeStereoMatricesCallback *callback)
ComputeStereoMatricesCallback * getComputeStereoMatricesCallback ()
const
ComputeStereoMatricesCallback * 
getComputeStereoMatricesCallback () const
bool projectWindowIntoObject (const osg::Vec3 &window, osg::Vec3 &object) const
bool projectWindowXYIntoObject (int x, int y, osg::Vec3 &near_point, osg::Vec3 &far_point) const
bool projectObjectIntoWindow (const osg::Vec3 &object, osg::Vec3 &window) const
void setFrameStamp (osg::FrameStamp *fs)
const osg::FrameStamp * getFrameStamp () const
osg::Matrixd computeLeftEyeProjection (const osg::Matrixd &projection) const
osg::Matrixd computeLeftEyeView (const osg::Matrixd &view) const
osg::Matrixd computeRightEyeProjection (const osg::Matrixd &projection) const
osg::Matrixd computeRightEyeView (const osg::Matrixd &view) const
virtual osg::Matrixd computeLeftEyeProjectionImplementation (const osg::Matrixd &projection) const
virtual osg::Matrixd computeLeftEyeViewImplementation (const osg::Matrixd &view) const
virtual osg::Matrixd computeRightEyeProjectionImplementation (const osg::Matrixd &projection) const
virtual osg::Matrixd computeRightEyeViewImplementation (const osg::Matrixd &view) const
virtual void inheritCullSettings (const osg::CullSettings &settings)
virtual void inheritCullSettings (const osg::CullSettings &settings, unsigned int inheritanceMask)
virtual void init ()
virtual void update ()
virtual void cull ()
virtual void draw ()
unsigned int getDynamicObjectCount () const
virtual void releaseAllGLObjects ()
virtual void flushAllDeletedGLObjects ()
virtual void flushDeletedGLObjects (double &availableTime)
bool getStats (Statistics &primStats)
void setAutomaticFlush (bool automaticFlush)
bool getAutomaticFlush () const
- Public Member Functions inherited from osg::Object
 Object ()
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual Object * cloneType () const =0
virtual Object * clone (const CopyOp &) const =0
virtual bool isSameKindAs (const Object *) const
virtual const char * libraryName () const =0
virtual const char * className () const =0
virtual void setThreadSafeRefUnref (bool threadSafe)
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::UserDataContainer * getUserDataContainer ()
const osg::UserDataContainer * getUserDataContainer () const
osg::UserDataContainer * getOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
virtual Referenced * getUserData ()
virtual const Referenced * getUserData () 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)
virtual void resizeGLObjectBuffers (unsigned int)
virtual void releaseGLObjects (osg::State *=0) const
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referenced & operator= (const Referenced &)
bool getThreadSafeRefUnref () const
OpenThreads::Mutex * getRefMutex () const
int ref () const
int unref () const
int unref_nodelete () const
int referenceCount () const
ObserverSet * getObserverSet () const
ObserverSet * getOrCreateObserverSet () const
void addObserver (Observer *observer) const
void removeObserver (Observer *observer) const
- Public Member Functions inherited from osg::CullSettings
 CullSettings ()
 CullSettings (ArgumentParser &arguments)
 CullSettings (const CullSettings &cs)
virtual ~CullSettings ()
CullSettings & operator= (const CullSettings &settings)
void setInheritanceMask (InheritanceMask mask)
InheritanceMask getInheritanceMask () const
void setCullSettings (const CullSettings &settings)
void readEnvironmentalVariables ()
void readCommandLine (ArgumentParser &arguments)
void setInheritanceMaskActionOnAttributeSetting (InheritanceMaskActionOnAttributeSetting action)
InheritanceMaskActionOnAttributeSetting getInheritanceMaskActionOnAttributeSetting () const
void applyMaskAction (unsigned int maskBit)
void setImpostorsActive (bool active)
bool getImpostorsActive () const
void setImpostorPixelErrorThreshold (float numPixels)
float getImpostorPixelErrorThreshold () const
void setDepthSortImpostorSprites (bool doDepthSort)
bool getDepthSortImpostorSprites () const
void setNumberOfFrameToKeepImpostorSprites (int numFrames)
int getNumberOfFrameToKeepImpostorSprites () const
void setComputeNearFarMode (ComputeNearFarMode cnfm)
ComputeNearFarMode getComputeNearFarMode () const
void setNearFarRatio (double ratio)
double getNearFarRatio () const
void setCullingMode (CullingMode mode)
CullingMode getCullingMode () const
void setCullMask (osg::Node::NodeMask nm)
osg::Node::NodeMask getCullMask () const
void setCullMaskLeft (osg::Node::NodeMask nm)
osg::Node::NodeMask getCullMaskLeft () const
void setCullMaskRight (osg::Node::NodeMask nm)
osg::Node::NodeMask getCullMaskRight () const
void setLODScale (float scale)
float getLODScale () const
void setSmallFeatureCullingPixelSize (float value)
float getSmallFeatureCullingPixelSize () const
void setClampProjectionMatrixCallback (ClampProjectionMatrixCallback *cpmc)
ClampProjectionMatrixCallback * getClampProjectionMatrixCallback ()
const
ClampProjectionMatrixCallback * 
getClampProjectionMatrixCallback () const
void write (std::ostream &out)

Protected Member Functions

virtual ~SceneView ()
virtual bool cullStage (const osg::Matrixd &projection, const osg::Matrixd &modelview, osgUtil::CullVisitor *cullVisitor, osgUtil::StateGraph *rendergraph, osgUtil::RenderStage *renderStage, osg::Viewport *viewport)
void computeLeftEyeViewport (const osg::Viewport *viewport)
void computeRightEyeViewport (const osg::Viewport *viewport)
const osg::Matrix computeMVPW () const
void clearArea (int x, int y, int width, int height, const osg::Vec4 &color)
- 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 Attributes

osg::ref_ptr< osg::StateSet > _localStateSet
osg::RenderInfo _renderInfo
bool _initCalled
osg::ref_ptr< osg::NodeVisitor > _initVisitor
osg::ref_ptr< osg::NodeVisitor > _updateVisitor
osg::ref_ptr
< osgUtil::CullVisitor > 
_cullVisitor
osg::ref_ptr< osgUtil::StateGraph > _stateGraph
osg::ref_ptr
< osgUtil::RenderStage > 
_renderStage
osg::ref_ptr
< ComputeStereoMatricesCallback > 
_computeStereoMatricesCallback
osg::ref_ptr
< osgUtil::CullVisitor > 
_cullVisitorLeft
osg::ref_ptr< osgUtil::StateGraph > _stateGraphLeft
osg::ref_ptr
< osgUtil::RenderStage > 
_renderStageLeft
osg::ref_ptr< osg::Viewport > _viewportLeft
osg::ref_ptr
< osgUtil::CullVisitor > 
_cullVisitorRight
osg::ref_ptr< osgUtil::StateGraph > _stateGraphRight
osg::ref_ptr
< osgUtil::RenderStage > 
_renderStageRight
osg::ref_ptr< osg::Viewport > _viewportRight
osg::ref_ptr
< osg::CollectOccludersVisitor > 
_collectOccludersVisitor
osg::ref_ptr< osg::FrameStamp > _frameStamp
osg::observer_ptr< osg::Camera > _camera
osg::ref_ptr< osg::Camera > _cameraWithOwnership
osg::ref_ptr< osg::StateSet > _globalStateSet
osg::ref_ptr< osg::Light > _light
osg::ref_ptr
< osg::DisplaySettings > 
_displaySettings
osg::ref_ptr< osg::StateSet > _secondaryStateSet
FusionDistanceMode _fusionDistanceMode
float _fusionDistanceValue
LightingMode _lightingMode
bool _prioritizeTextures
bool _automaticFlush
bool _requiresFlush
int _activeUniforms
double _previousFrameTime
double _previousSimulationTime
bool _redrawInterlacedStereoStencilMask
int _interlacedStereoStencilWidth
int _interlacedStereoStencilHeight
unsigned int _dynamicObjectCount
- 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
- Protected Attributes inherited from osg::CullSettings
InheritanceMask _inheritanceMask
InheritanceMaskActionOnAttributeSetting _inheritanceMaskActionOnAttributeSetting
ComputeNearFarMode _computeNearFar
CullingMode _cullingMode
float _LODScale
float _smallFeatureCullingPixelSize
ref_ptr
< ClampProjectionMatrixCallback > 
_clampProjectionMatrixCallback
double _nearFarRatio
bool _impostorActive
bool _depthSortImpostorSprites
float _impostorPixelErrorThreshold
int _numFramesToKeepImpostorSprites
Node::NodeMask _cullMask
Node::NodeMask _cullMaskLeft
Node::NodeMask _cullMaskRight

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex * getGlobalReferencedMutex ()
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool getThreadSafeReferenceCounting ()
static void setDeleteHandler (DeleteHandler *handler)
static DeleteHandler * getDeleteHandler ()

Detailed Description

SceneView is deprecated, and is now just kept for backwards compatibility. It is recommend that you use osgViewer::Viewer/Composite in combination with osgViewer::GraphicsWindowEmbedded for embedded rendering support as this provides a greater range of functionality and consistency of API.

Member Typedef Documentation

Member Enumeration Documentation

Enumerator:
FRAME_NUMBER_UNIFORM 
FRAME_TIME_UNIFORM 
DELTA_FRAME_TIME_UNIFORM 
SIMULATION_TIME_UNIFORM 
DELTA_SIMULATION_TIME_UNIFORM 
VIEW_MATRIX_UNIFORM 
VIEW_MATRIX_INVERSE_UNIFORM 
DEFAULT_UNIFORMS 
ALL_UNIFORMS 

FusionDistanceMode is used only when working in stereo.

Enumerator:
USE_FUSION_DISTANCE_VALUE 

Use fusion distance from the value set on the SceneView.

PROPORTIONAL_TO_SCREEN_DISTANCE 

Compute the fusion distance by multiplying the screen distance by the fusion distance value.

Enumerator:
NO_SCENEVIEW_LIGHT 
HEADLIGHT 
SKY_LIGHT 
COMPILE_GLOBJECTS_AT_INIT 
STANDARD_SETTINGS 

Constructor & Destructor Documentation

osgUtil::SceneView::SceneView ( osg::DisplaySettings *  ds = NULL)

Construct a default scene view.

osgUtil::SceneView::SceneView ( const SceneView &  sceneview,
const osg::CopyOp &  copyop = osg::CopyOp() 
)
virtual osgUtil::SceneView::~SceneView ( )
protectedvirtual

Member Function Documentation

void osgUtil::SceneView::clearArea ( int  x,
int  y,
int  width,
int  height,
const osg::Vec4 &  color 
)
protected
void osgUtil::SceneView::clearReferencesToDependentCameras ( )

clear the refence to any any dependent cameras.

void osgUtil::SceneView::collateReferencesToDependentCameras ( )

search through any pre and post RenderStage that reference a Camera, and take a reference to each of these cameras to prevent them being deleted while they are still be used by the drawing thread.

osg::Matrixd osgUtil::SceneView::computeLeftEyeProjection ( const osg::Matrixd &  projection) const
inline
virtual osg::Matrixd osgUtil::SceneView::computeLeftEyeProjectionImplementation ( const osg::Matrixd &  projection) const
virtual
osg::Matrixd osgUtil::SceneView::computeLeftEyeView ( const osg::Matrixd &  view) const
inline
virtual osg::Matrixd osgUtil::SceneView::computeLeftEyeViewImplementation ( const osg::Matrixd &  view) const
virtual
void osgUtil::SceneView::computeLeftEyeViewport ( const osg::Viewport *  viewport)
protected
const osg::Matrix osgUtil::SceneView::computeMVPW ( ) const
protected
osg::Matrixd osgUtil::SceneView::computeRightEyeProjection ( const osg::Matrixd &  projection) const
inline
virtual osg::Matrixd osgUtil::SceneView::computeRightEyeProjectionImplementation ( const osg::Matrixd &  projection) const
virtual
osg::Matrixd osgUtil::SceneView::computeRightEyeView ( const osg::Matrixd &  view) const
inline
virtual osg::Matrixd osgUtil::SceneView::computeRightEyeViewImplementation ( const osg::Matrixd &  view) const
virtual
void osgUtil::SceneView::computeRightEyeViewport ( const osg::Viewport *  viewport)
protected
virtual void osgUtil::SceneView::cull ( )
virtual

Do cull traversal of attached scene graph using Cull NodeVisitor.

virtual bool osgUtil::SceneView::cullStage ( const osg::Matrixd &  projection,
const osg::Matrixd &  modelview,
osgUtil::CullVisitor *  cullVisitor,
osgUtil::StateGraph *  rendergraph,
osgUtil::RenderStage *  renderStage,
osg::Viewport *  viewport 
)
protectedvirtual

Do cull traversal of attached scene graph using Cull NodeVisitor. Return true if computeNearFar has been done during the cull traversal.

virtual void osgUtil::SceneView::draw ( )
virtual

Do draw traversal of draw bins generated by cull traversal.

virtual void osgUtil::SceneView::flushAllDeletedGLObjects ( )
virtual

Flush all deleted OpenGL objects, such as texture objects, display lists etc.

virtual void osgUtil::SceneView::flushDeletedGLObjects ( double &  availableTime)
virtual

Flush deleted OpenGL objects, such as texture objects, display lists etc within specified available time.

int osgUtil::SceneView::getActiveUniforms ( ) const
inline

Get the uniforms that SceneView should set set up on each frame.

bool osgUtil::SceneView::getAutomaticFlush ( ) const
inline
osg::Camera* osgUtil::SceneView::getCamera ( )
inline

Get the camera used to represent the camera view of this SceneView.

const osg::Camera* osgUtil::SceneView::getCamera ( ) const
inline

Get the const camera used to represent the camera view of this SceneView.

const osg::Vec4& osgUtil::SceneView::getClearColor ( ) const
inline

Get the color used in glClearColor.

osg::CollectOccludersVisitor* osgUtil::SceneView::getCollectOccludersVisitor ( )
inline
const osg::CollectOccludersVisitor* osgUtil::SceneView::getCollectOccludersVisitor ( ) const
inline
ComputeStereoMatricesCallback* osgUtil::SceneView::getComputeStereoMatricesCallback ( )
inline
const ComputeStereoMatricesCallback* osgUtil::SceneView::getComputeStereoMatricesCallback ( ) const
inline
osgUtil::CullVisitor* osgUtil::SceneView::getCullVisitor ( )
inline
const osgUtil::CullVisitor* osgUtil::SceneView::getCullVisitor ( ) const
inline
osgUtil::CullVisitor* osgUtil::SceneView::getCullVisitorLeft ( )
inline
const osgUtil::CullVisitor* osgUtil::SceneView::getCullVisitorLeft ( ) const
inline
osgUtil::CullVisitor* osgUtil::SceneView::getCullVisitorRight ( )
inline
const osgUtil::CullVisitor* osgUtil::SceneView::getCullVisitorRight ( ) const
inline
const osg::DisplaySettings* osgUtil::SceneView::getDisplaySettings ( ) const
inline

Get the const DisplaySettings

osg::DisplaySettings* osgUtil::SceneView::getDisplaySettings ( )
inline

Get the DisplaySettings

GLenum osgUtil::SceneView::getDrawBufferValue ( ) const
inline

Get the draw buffer value used at the start of each frame draw.

unsigned int osgUtil::SceneView::getDynamicObjectCount ( ) const
inline

Compute the number of dynamic objects that will be held in the rendering backend

const osg::FrameStamp* osgUtil::SceneView::getFrameStamp ( ) const
inline

Get the frame stamp for the current frame.

FusionDistanceMode osgUtil::SceneView::getFusionDistanceMode ( ) const
inline

Get the FusionDistanceMode.

float osgUtil::SceneView::getFusionDistanceValue ( ) const
inline

Get the FusionDistanceValue. Note, only used for USE_FUSION_DISTANCE_VALUE & PROPORTIONAL_TO_SCREEN_DISTANCE modes.

osg::StateSet* osgUtil::SceneView::getGlobalStateSet ( )
inline
const osg::StateSet* osgUtil::SceneView::getGlobalStateSet ( ) const
inline
osg::NodeVisitor* osgUtil::SceneView::getInitVisitor ( )
inline
const osg::NodeVisitor* osgUtil::SceneView::getInitVisitor ( ) const
inline
osg::Light* osgUtil::SceneView::getLight ( )
inline
const osg::Light* osgUtil::SceneView::getLight ( ) const
inline
LightingMode osgUtil::SceneView::getLightingMode ( ) const
inline
osg::StateSet* osgUtil::SceneView::getLocalStateSet ( )
inline
const osg::StateSet* osgUtil::SceneView::getLocalStateSet ( ) const
inline
unsigned int osgUtil::SceneView::getNumSceneData ( ) const
inline

Get the number of scene data subgraphs added to the SceneView's camera.

bool osgUtil::SceneView::getPrioritizeTextures ( ) const
inline

Get whether the draw method should call renderer->prioritizeTexture.

osg::Matrixd& osgUtil::SceneView::getProjectionMatrix ( )
inline

Get the projection matrix.

const osg::Matrixd& osgUtil::SceneView::getProjectionMatrix ( ) const
inline

Get the const projection matrix.

bool osgUtil::SceneView::getProjectionMatrixAsFrustum ( double &  left,
double &  right,
double &  bottom,
double &  top,
double &  zNear,
double &  zFar 
) const

Get the frustum setting of a perspective projection matrix. Returns false if matrix is not a perspective matrix, where parameter values are undefined.

bool osgUtil::SceneView::getProjectionMatrixAsOrtho ( double &  left,
double &  right,
double &  bottom,
double &  top,
double &  zNear,
double &  zFar 
) const

Get the orthographic settings of the orthographic projection matrix. Returns false if matrix is not an orthographic matrix, where parameter values are undefined.

bool osgUtil::SceneView::getProjectionMatrixAsPerspective ( double &  fovy,
double &  aspectRatio,
double &  zNear,
double &  zFar 
) const

Get the frustum setting of a symmetric perspective projection matrix. Returns false if matrix is not a perspective matrix, where parameter values are undefined. Note, if matrix is not a symmetric perspective matrix then the shear will be lost. Asymmetric matrices occur when stereo, power walls, caves and reality center display are used. In these configurations one should use the 'getProjectionMatrixAsFrustum' method instead.

bool osgUtil::SceneView::getRedrawInterlacedStereoStencilMask ( ) const
inline

Get the redraw interlaced stereo stencil mask request flag.

osg::RenderInfo& osgUtil::SceneView::getRenderInfo ( )
inline
const osg::RenderInfo& osgUtil::SceneView::getRenderInfo ( ) const
inline
osgUtil::RenderStage* osgUtil::SceneView::getRenderStage ( )
inline
const osgUtil::RenderStage* osgUtil::SceneView::getRenderStage ( ) const
inline
osgUtil::RenderStage* osgUtil::SceneView::getRenderStageLeft ( )
inline
const osgUtil::RenderStage* osgUtil::SceneView::getRenderStageLeft ( ) const
inline
osgUtil::RenderStage* osgUtil::SceneView::getRenderStageRight ( )
inline
const osgUtil::RenderStage* osgUtil::SceneView::getRenderStageRight ( ) const
inline
osg::Node* osgUtil::SceneView::getSceneData ( unsigned int  childNo = 0)
inline

Get the scene data to view. The data will typically be an osg::Scene but can be any osg::Node type.

const osg::Node* osgUtil::SceneView::getSceneData ( unsigned int  childNo = 0) const
inline

Get the const scene data which to view. The data will typically be an osg::Scene but can be any osg::Node type.

osg::StateSet* osgUtil::SceneView::getSecondaryStateSet ( )
inline
const osg::StateSet* osgUtil::SceneView::getSecondaryStateSet ( ) const
inline
osg::State* osgUtil::SceneView::getState ( )
inline
const osg::State* osgUtil::SceneView::getState ( ) const
inline
osgUtil::StateGraph* osgUtil::SceneView::getStateGraph ( )
inline
const osgUtil::StateGraph* osgUtil::SceneView::getStateGraph ( ) const
inline
osgUtil::StateGraph* osgUtil::SceneView::getStateGraphLeft ( )
inline
const osgUtil::StateGraph* osgUtil::SceneView::getStateGraphLeft ( ) const
inline
osgUtil::StateGraph* osgUtil::SceneView::getStateGraphRight ( )
inline
const osgUtil::StateGraph* osgUtil::SceneView::getStateGraphRight ( ) const
inline
bool osgUtil::SceneView::getStats ( Statistics &  primStats)

Extract stats for current draw list.

osg::NodeVisitor* osgUtil::SceneView::getUpdateVisitor ( )
inline
const osg::NodeVisitor* osgUtil::SceneView::getUpdateVisitor ( ) const
inline
osg::View* osgUtil::SceneView::getView ( )
inline
const osg::View* osgUtil::SceneView::getView ( ) const
inline
osg::Matrixd& osgUtil::SceneView::getViewMatrix ( )
inline

Get the view matrix.

const osg::Matrixd& osgUtil::SceneView::getViewMatrix ( ) const
inline

Get the const view matrix.

void osgUtil::SceneView::getViewMatrixAsLookAt ( osg::Vec3 &  eye,
osg::Vec3 &  center,
osg::Vec3 &  up,
float  lookDistance = 1.0f 
) const

Get to the position and orientation of a modelview matrix, using the same convention as gluLookAt.

osg::Viewport* osgUtil::SceneView::getViewport ( )
inline

Get the viewport.

const osg::Viewport* osgUtil::SceneView::getViewport ( ) const
inline

Get the const viewport.

virtual void osgUtil::SceneView::inheritCullSettings ( const osg::CullSettings &  settings)
inlinevirtual

Inherit the local cull settings variable from specified CullSettings object, according to the inheritance mask.

Reimplemented from osg::CullSettings.

References inheritCullSettings().

Referenced by inheritCullSettings().

virtual void osgUtil::SceneView::inheritCullSettings ( const osg::CullSettings &  settings,
unsigned int  inheritanceMask 
)
virtual

Inherit the local cull settings variable from specified CullSettings object, according to the inheritance mask.

Reimplemented from osg::CullSettings.

virtual void osgUtil::SceneView::init ( )
virtual

Do init traversal of attached scene graph using Init NodeVisitor. The init traversal is called once for each SceneView, and should be used to compile display list, texture objects intialize data not otherwise intialized during scene graph loading. Note, is called automatically by update & cull if it hasn't already been called elsewhere. Also init() should only ever be called within a valid graphics context.

osgUtil::SceneView::META_Object ( osgUtil  ,
SceneView   
)
bool osgUtil::SceneView::projectObjectIntoWindow ( const osg::Vec3 &  object,
osg::Vec3 &  window 
) const

Calculate the window coordinates of a point in object coordinates. Note, current implementation requires that SceneView::draw() has been previously called for projectWindowIntoObject to produce valid values. Consistent with OpenGL windows coordinates are calculated relative to the bottom left of the window, whereas window API's normally have the top left as the origin, so you may need to pass in (mouseX,window_height-mouseY,...). Returns true on successful projection.

bool osgUtil::SceneView::projectWindowIntoObject ( const osg::Vec3 &  window,
osg::Vec3 &  object 
) const

Calculate the object coordinates of a point in window coordinates. Note, current implementation requires that SceneView::draw() has been previously called for projectWindowIntoObject to produce valid values. Consistent with OpenGL windows coordinates are calculated relative to the bottom left of the window. Returns true on successful projection.

bool osgUtil::SceneView::projectWindowXYIntoObject ( int  x,
int  y,
osg::Vec3 &  near_point,
osg::Vec3 &  far_point 
) const

Calculate the object coordinates of a window x,y when projected onto the near and far planes. Note, current implementation requires that SceneView::draw() has been previously called for projectWindowIntoObject to produce valid values. Consistent with OpenGL windows coordinates are calculated relative to the bottom left of the window. Returns true on successful projection.

virtual void osgUtil::SceneView::releaseAllGLObjects ( )
virtual

Release all OpenGL objects from the scene graph, such as texture objects, display lists etc. These released scene graphs placed in the respective delete GLObjects cache, which then need to be deleted in OpenGL by SceneView::flushAllDeleteGLObjects().

void osgUtil::SceneView::setActiveUniforms ( int  activeUniforms)
inline

Set the uniforms that SceneView should set set up on each frame.

void osgUtil::SceneView::setAutomaticFlush ( bool  automaticFlush)
inline

Set whether the SceneView should automatically call flishDeletedObjects() on each new frame.

void osgUtil::SceneView::setCamera ( osg::Camera *  camera,
bool  assumeOwnershipOfCamera = true 
)

Set the camera used to represent the camera view of this SceneView.

void osgUtil::SceneView::setClearColor ( const osg::Vec4 &  color)
inline

Set the color used in glClearColor(). Defaults to an off blue color.

void osgUtil::SceneView::setCollectOccludersVisitor ( osg::CollectOccludersVisitor *  cov)
inline
void osgUtil::SceneView::setComputeStereoMatricesCallback ( ComputeStereoMatricesCallback *  callback)
inline
void osgUtil::SceneView::setCullVisitor ( osgUtil::CullVisitor *  cv)
inline
void osgUtil::SceneView::setCullVisitorLeft ( osgUtil::CullVisitor *  cv)
inline
void osgUtil::SceneView::setCullVisitorRight ( osgUtil::CullVisitor *  cv)
inline
virtual void osgUtil::SceneView::setDefaults ( )
inlinevirtual

Reimplemented from osg::CullSettings.

References setDefaults().

Referenced by setDefaults().

virtual void osgUtil::SceneView::setDefaults ( unsigned int  options)
virtual

Set scene view to use default global state, light, camera and render visitor.

void osgUtil::SceneView::setDisplaySettings ( osg::DisplaySettings *  vs)
inline

Set the DisplaySettings.

void osgUtil::SceneView::setDrawBufferValue ( GLenum  drawBufferValue)
inline

Set the draw buffer value used at the start of each frame draw. Note, overridden in quad buffer stereo mode

void osgUtil::SceneView::setFrameStamp ( osg::FrameStamp *  fs)
inline

Set the frame stamp for the current frame.

void osgUtil::SceneView::setFusionDistance ( FusionDistanceMode  mode,
float  value = 1.0f 
)
inline

Set the FusionDistanceMode and Value. Note, is used only when working in stereo.

void osgUtil::SceneView::setGlobalStateSet ( osg::StateSet *  state)
inline
void osgUtil::SceneView::setInitVisitor ( osg::NodeVisitor *  av)
inline
void osgUtil::SceneView::setLight ( osg::Light *  light)
inline
void osgUtil::SceneView::setLightingMode ( LightingMode  mode)
void osgUtil::SceneView::setLocalStateSet ( osg::StateSet *  state)
inline
void osgUtil::SceneView::setPrioritizeTextures ( bool  pt)
inline

Set whether the draw method should call renderer->prioritizeTexture.

void osgUtil::SceneView::setProjectionMatrix ( const osg::Matrixf &  matrix)
inline

Set the projection matrix. Can be thought of as setting the lens of a camera.

void osgUtil::SceneView::setProjectionMatrix ( const osg::Matrixd &  matrix)
inline

Set the projection matrix. Can be thought of as setting the lens of a camera.

void osgUtil::SceneView::setProjectionMatrixAsFrustum ( double  left,
double  right,
double  bottom,
double  top,
double  zNear,
double  zFar 
)

Set to a perspective projection. See OpenGL glFrustum documentation for further details.

void osgUtil::SceneView::setProjectionMatrixAsOrtho ( double  left,
double  right,
double  bottom,
double  top,
double  zNear,
double  zFar 
)

Set to an orthographic projection. See OpenGL glOrtho for documentation further details.

void osgUtil::SceneView::setProjectionMatrixAsOrtho2D ( double  left,
double  right,
double  bottom,
double  top 
)

Set to a 2D orthographic projection. See OpenGL glOrtho2D documentation for further details.

void osgUtil::SceneView::setProjectionMatrixAsPerspective ( double  fovy,
double  aspectRatio,
double  zNear,
double  zFar 
)

Create a symmetrical perspective projection, See OpenGL gluPerspective documentation for further details. Aspect ratio is defined as width/height.

void osgUtil::SceneView::setRedrawInterlacedStereoStencilMask ( bool  flag)
inline

Manually set the redraw interlaced stereo stencil mask request flag to control whether to redraw the stencil buffer on the next frame.

void osgUtil::SceneView::setRenderInfo ( osg::RenderInfo &  renderInfo)
inline
void osgUtil::SceneView::setRenderStage ( osgUtil::RenderStage *  rs)
inline
void osgUtil::SceneView::setRenderStageLeft ( osgUtil::RenderStage *  rs)
inline
void osgUtil::SceneView::setRenderStageRight ( osgUtil::RenderStage *  rs)
inline
void osgUtil::SceneView::setSceneData ( osg::Node *  node)

Set the data to view. The data will typically be an osg::Scene but can be any osg::Node type.

void osgUtil::SceneView::setSecondaryStateSet ( osg::StateSet *  state)
inline
void osgUtil::SceneView::setState ( osg::State *  state)
inline
void osgUtil::SceneView::setStateGraph ( osgUtil::StateGraph *  rg)
inline
void osgUtil::SceneView::setStateGraphLeft ( osgUtil::StateGraph *  rg)
inline
void osgUtil::SceneView::setStateGraphRight ( osgUtil::StateGraph *  rg)
inline
void osgUtil::SceneView::setUpdateVisitor ( osg::NodeVisitor *  av)
inline
void osgUtil::SceneView::setView ( osg::View *  view)
inline
void osgUtil::SceneView::setViewMatrix ( const osg::Matrixf &  matrix)
inline

Set the view matrix. Can be thought of as setting the position of the world relative to the camera in camera coordinates.

void osgUtil::SceneView::setViewMatrix ( const osg::Matrixd &  matrix)
inline

Set the view matrix. Can be thought of as setting the position of the world relative to the camera in camera coordinates.

void osgUtil::SceneView::setViewMatrixAsLookAt ( const osg::Vec3 &  eye,
const osg::Vec3 &  center,
const osg::Vec3 &  up 
)

Set to the position and orientation of view matrix, using the same convention as gluLookAt.

void osgUtil::SceneView::setViewport ( osg::Viewport *  viewport)
inline

Set the viewport of the scene view to use specified osg::Viewport.

void osgUtil::SceneView::setViewport ( int  x,
int  y,
int  width,
int  height 
)
inline

Set the viewport of the scene view to specified dimensions.

virtual void osgUtil::SceneView::update ( )
virtual

Do app traversal of attached scene graph using App NodeVisitor.

void osgUtil::SceneView::updateUniforms ( )

Member Data Documentation

int osgUtil::SceneView::_activeUniforms
protected
bool osgUtil::SceneView::_automaticFlush
protected
osg::observer_ptr<osg::Camera> osgUtil::SceneView::_camera
protected
osg::ref_ptr<osg::Camera> osgUtil::SceneView::_cameraWithOwnership
protected
osg::ref_ptr<osg::CollectOccludersVisitor> osgUtil::SceneView::_collectOccludersVisitor
protected
osg::ref_ptr<ComputeStereoMatricesCallback> osgUtil::SceneView::_computeStereoMatricesCallback
protected
osg::ref_ptr<osgUtil::CullVisitor> osgUtil::SceneView::_cullVisitor
protected
osg::ref_ptr<osgUtil::CullVisitor> osgUtil::SceneView::_cullVisitorLeft
protected
osg::ref_ptr<osgUtil::CullVisitor> osgUtil::SceneView::_cullVisitorRight
protected
osg::ref_ptr<osg::DisplaySettings> osgUtil::SceneView::_displaySettings
protected
unsigned int osgUtil::SceneView::_dynamicObjectCount
protected
osg::ref_ptr<osg::FrameStamp> osgUtil::SceneView::_frameStamp
protected
FusionDistanceMode osgUtil::SceneView::_fusionDistanceMode
protected
float osgUtil::SceneView::_fusionDistanceValue
protected
osg::ref_ptr<osg::StateSet> osgUtil::SceneView::_globalStateSet
protected
bool osgUtil::SceneView::_initCalled
protected
osg::ref_ptr<osg::NodeVisitor> osgUtil::SceneView::_initVisitor
protected
int osgUtil::SceneView::_interlacedStereoStencilHeight
protected
int osgUtil::SceneView::_interlacedStereoStencilWidth
protected
osg::ref_ptr<osg::Light> osgUtil::SceneView::_light
protected
LightingMode osgUtil::SceneView::_lightingMode
protected
osg::ref_ptr<osg::StateSet> osgUtil::SceneView::_localStateSet
protected
double osgUtil::SceneView::_previousFrameTime
protected
double osgUtil::SceneView::_previousSimulationTime
protected
bool osgUtil::SceneView::_prioritizeTextures
protected
bool osgUtil::SceneView::_redrawInterlacedStereoStencilMask
protected
osg::RenderInfo osgUtil::SceneView::_renderInfo
protected
osg::ref_ptr<osgUtil::RenderStage> osgUtil::SceneView::_renderStage
protected
osg::ref_ptr<osgUtil::RenderStage> osgUtil::SceneView::_renderStageLeft
protected
osg::ref_ptr<osgUtil::RenderStage> osgUtil::SceneView::_renderStageRight
protected
bool osgUtil::SceneView::_requiresFlush
protected
osg::ref_ptr<osg::StateSet> osgUtil::SceneView::_secondaryStateSet
protected
osg::ref_ptr<osgUtil::StateGraph> osgUtil::SceneView::_stateGraph
protected
osg::ref_ptr<osgUtil::StateGraph> osgUtil::SceneView::_stateGraphLeft
protected
osg::ref_ptr<osgUtil::StateGraph> osgUtil::SceneView::_stateGraphRight
protected
osg::ref_ptr<osg::NodeVisitor> osgUtil::SceneView::_updateVisitor
protected
osg::ref_ptr<osg::Viewport> osgUtil::SceneView::_viewportLeft
protected
osg::ref_ptr<osg::Viewport> osgUtil::SceneView::_viewportRight
protected

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