OpenWalnut
1.4.0
|
Image Overlay Effect. More...
#include <WGEViewerEffectImageOverlay.h>
Classes | |
class | Updater |
Update the uniforms and textures if needed. More... | |
Public Types | |
typedef osg::ref_ptr< WGEViewerEffectImageOverlay > | SPtr |
Convenience typedef for a boost::shared_ptr< WGEViewerEffectImageOverlay >. More... | |
typedef osg::ref_ptr< const WGEViewerEffectImageOverlay > | ConstSPtr |
Convenience typedef for a boost::shared_ptr< const WGEViewerEffectImageOverlay >. More... | |
![]() | |
typedef osg::ref_ptr< WGEViewerEffect > | SPtr |
Convenience typedef for a boost::shared_ptr< WGEViewerEffect >. More... | |
typedef osg::ref_ptr< const WGEViewerEffect > | ConstSPtr |
Convenience typedef for a boost::shared_ptr< const WGEViewerEffect >. More... | |
![]() | |
typedef boost::shared_ptr< WObjectNDIP > | SPtr |
Shared ptr to an instance. More... | |
typedef boost::shared_ptr< const WObjectNDIP > | ConstSPtr |
Shared ptr to a const instance. More... | |
![]() | |
enum | ProjectionMode { ORTHOGRAPHIC, PERSPECTIVE, TWO_D, TWO_D_UNIT } |
List of possible camera modes. More... | |
Public Member Functions | |
WGEViewerEffectImageOverlay () | |
Default constructor. More... | |
virtual | ~WGEViewerEffectImageOverlay () |
Destructor. More... | |
void | setReferenceViewer (boost::shared_ptr< WGEViewer > viewer) |
Set the reference viewer. More... | |
const boost::shared_ptr< WGEViewer > | getReferenceViewer () const |
Query current reference viewer. More... | |
![]() | |
WGEViewerEffect (std::string name, std::string description, const char **icon=NULL) | |
Create the effect. More... | |
virtual | ~WGEViewerEffect () |
Destructor. More... | |
virtual bool | isEnabled () const |
Check whether the effect is active or not. More... | |
virtual void | setEnabled (bool enable=true) |
Set the effect enabled. More... | |
virtual void | setEnabledByDefault (bool enableByDefault=true) |
Use this to activate an effect by default. More... | |
![]() | |
virtual | ~WObjectNDIP () |
Destructor. More... | |
virtual std::string | getName () const |
The name of the object. More... | |
virtual std::string | getDescription () const |
The description of this object. More... | |
virtual const char ** | getIcon () const |
The icon of this object. More... | |
virtual WProperties::SPtr | getProperties () |
Return the property group of this object. More... | |
![]() | |
WGECamera (int width, int height, ProjectionMode projectionMode) | |
Constructor which sets defaults. More... | |
WGECamera () | |
Constructor which sets defaults. More... | |
void | setDefaultProjectionMode (ProjectionMode mode) |
Sets the default projection mode used for cameras getting reset. More... | |
ProjectionMode | getDefaultProjectionMode () |
Returns the current default projection mode. More... | |
void | reset () |
Resets the camera and activates the prior set defaults. More... | |
void | resize () |
Change camera parameters which should be changed on a resize. More... | |
Protected Attributes | |
osg::ref_ptr< osg::Uniform > | m_overlayWidth |
Width of the image in pixels. More... | |
osg::ref_ptr< osg::Uniform > | m_overlayHeight |
Height of the image in pixels. More... | |
osg::ref_ptr< osg::Uniform > | m_viewportWidth |
Width of the viewport in pixels. More... | |
osg::ref_ptr< osg::Uniform > | m_viewportHeight |
Height of the viewport in pixels. More... | |
boost::shared_ptr< WGEViewer > | m_viewer |
The viewer used to query the current reference cam. More... | |
WPropFilename | m_image |
The filename to load. More... | |
osg::ref_ptr< osg::Texture2D > | m_logoTexture |
The texture. More... | |
bool | m_forceReload |
If true, the update callback is forced to reload the image. More... | |
![]() | |
osg::ref_ptr< osg::Geode > | m_geode |
The fullscreen quad. More... | |
osg::ref_ptr< osg::StateSet > | m_state |
The stateset of the cam. More... | |
WPropBool | m_active |
Enable or disable effect. More... | |
![]() | |
WProperties::SPtr | m_properties |
the properties of the object. More... | |
![]() | |
ProjectionMode | m_DefProjMode |
The projection mode used as default. More... | |
Private Attributes | |
osg::ref_ptr< Updater > | m_updater |
Update callback for the viewport. More... | |
Additional Inherited Members | |
![]() | |
WObjectNDIP (std::string name, std::string description, const char **icon=NULL) | |
Construct a NDIP'ed object. More... | |
![]() | |
virtual | ~WGECamera () |
Destructor. More... | |
Image Overlay Effect.
Definition at line 37 of file WGEViewerEffectImageOverlay.h.
typedef osg::ref_ptr< const WGEViewerEffectImageOverlay > WGEViewerEffectImageOverlay::ConstSPtr |
Convenience typedef for a boost::shared_ptr< const WGEViewerEffectImageOverlay >.
Definition at line 48 of file WGEViewerEffectImageOverlay.h.
typedef osg::ref_ptr< WGEViewerEffectImageOverlay > WGEViewerEffectImageOverlay::SPtr |
Convenience typedef for a boost::shared_ptr< WGEViewerEffectImageOverlay >.
Definition at line 43 of file WGEViewerEffectImageOverlay.h.
WGEViewerEffectImageOverlay::WGEViewerEffectImageOverlay | ( | ) |
Default constructor.
Definition at line 42 of file WGEViewerEffectImageOverlay.cpp.
References WPathHelper::getSharePath(), m_forceReload, WGEViewerEffect::m_geode, m_image, m_logoTexture, m_overlayHeight, m_overlayWidth, WObjectNDIP< WGECamera >::m_properties, WGEViewerEffect::m_state, m_updater, m_viewportHeight, and m_viewportWidth.
|
virtual |
Destructor.
Definition at line 95 of file WGEViewerEffectImageOverlay.cpp.
const boost::shared_ptr< WGEViewer > WGEViewerEffectImageOverlay::getReferenceViewer | ( | ) | const |
Query current reference viewer.
Definition at line 105 of file WGEViewerEffectImageOverlay.cpp.
References m_viewer.
void WGEViewerEffectImageOverlay::setReferenceViewer | ( | boost::shared_ptr< WGEViewer > | viewer | ) |
Set the reference viewer.
Needed as the effect itself is not able to query important camera states. This can be the viewer on which the effect is applied but does not have to. Important is a valid WGECamera, including a properly setup viewport.
viewer | the viewer in which the effect is used. |
Definition at line 100 of file WGEViewerEffectImageOverlay.cpp.
References m_viewer.
|
protected |
If true, the update callback is forced to reload the image.
Definition at line 114 of file WGEViewerEffectImageOverlay.h.
Referenced by WGEViewerEffectImageOverlay::Updater::operator()(), and WGEViewerEffectImageOverlay().
|
protected |
The filename to load.
Definition at line 104 of file WGEViewerEffectImageOverlay.h.
Referenced by WGEViewerEffectImageOverlay::Updater::operator()(), and WGEViewerEffectImageOverlay().
|
protected |
The texture.
Definition at line 109 of file WGEViewerEffectImageOverlay.h.
Referenced by WGEViewerEffectImageOverlay::Updater::operator()(), and WGEViewerEffectImageOverlay().
|
protected |
Height of the image in pixels.
Definition at line 84 of file WGEViewerEffectImageOverlay.h.
Referenced by WGEViewerEffectImageOverlay::Updater::operator()(), and WGEViewerEffectImageOverlay().
|
protected |
Width of the image in pixels.
Definition at line 79 of file WGEViewerEffectImageOverlay.h.
Referenced by WGEViewerEffectImageOverlay::Updater::operator()(), and WGEViewerEffectImageOverlay().
|
private |
Update callback for the viewport.
Definition at line 134 of file WGEViewerEffectImageOverlay.h.
Referenced by WGEViewerEffectImageOverlay().
|
protected |
The viewer used to query the current reference cam.
Definition at line 99 of file WGEViewerEffectImageOverlay.h.
Referenced by getReferenceViewer(), WGEViewerEffectImageOverlay::Updater::operator()(), and setReferenceViewer().
|
protected |
Height of the viewport in pixels.
Definition at line 94 of file WGEViewerEffectImageOverlay.h.
Referenced by WGEViewerEffectImageOverlay::Updater::operator()(), and WGEViewerEffectImageOverlay().
|
protected |
Width of the viewport in pixels.
Definition at line 89 of file WGEViewerEffectImageOverlay.h.
Referenced by WGEViewerEffectImageOverlay::Updater::operator()(), and WGEViewerEffectImageOverlay().