![]() |
OGRE
2.1.0unstable
Object-Oriented Graphics Rendering Engine
|
#include <OgreParallaxCorrectedCubemap.h>
Public Member Functions | |
ParallaxCorrectedCubemap (IdType id, Root *root, SceneManager *sceneManager, const CompositorWorkspaceDef *probeWorkspaceDef, uint8 reservedRqId, uint32 proxyVisibilityMask) | |
~ParallaxCorrectedCubemap () | |
void | _addManuallyActiveProbe (CubemapProbe *probe) |
void | _notifyPreparePassHash (const Matrix4 &viewMatrix) |
void | _removeManuallyActiveProbe (CubemapProbe *probe) |
virtual void | allWorkspacesBeforeBeginUpdate (void) |
Called from CompositorManager2 (not CompositorWorkspace) when we're about to begin updating all the workspaces. More... | |
virtual void | allWorkspacesBeginUpdate (void) |
Called from CompositorManager2 (not CompositorWorkspace) when we're about to update all the workspaces (it's safe to update your own workspaces without calling _beginUpdate and _endUpdate) Warning: Don't add/remove listeners to CompositorManager2 inside this function. More... | |
CubemapProbe * | createProbe (void) |
Adds a cubemap probe. More... | |
void | createProxyItems (void) |
Creates the Proxy Items. More... | |
void | destroyAllProbes (void) |
void | destroyProbe (CubemapProbe *probe) |
void | destroyProxyItems (void) |
Destroys the Proxy Items. More... | |
void | fillConstBufferData (const Matrix4 &viewMatrix, float *RESTRICT_ALIAS passBufferPtr) const |
void | fillConstBufferData (const CubemapProbe &probe, const Matrix4 &viewMatrix, const Matrix3 &invViewMat3, float *RESTRICT_ALIAS passBufferPtr) const |
TexturePtr | findTmpRtt (const TexturePtr &baseParams) |
See mTmpRtt. More... | |
virtual bool | frameEnded (const FrameEvent &evt) |
Called just after a frame has been rendered. More... | |
virtual bool | frameRenderingQueued (const FrameEvent &evt) |
Called after all render targets have had their rendering commands issued, but before render windows have been asked to flip their buffers over. More... | |
virtual bool | frameStarted (const FrameEvent &evt) |
Called when a frame is about to begin rendering. More... | |
TexturePtr | getBlendCubemap (void) const |
const HlmsSamplerblock * | getBlendCubemapTrilinearSamplerblock (void) |
const CompositorWorkspaceDef * | getDefaultWorkspaceDef (void) const |
bool | getEnabled (void) const |
IdType | getId () const |
Get the unique id of this object. More... | |
uint32 | getNumCollectedProbes (void) const |
const CubemapProbeVec & | getProbes (void) const |
Item *const * | getProxyItems (void) const |
uint8 | getProxyReservedRenderQueueId (void) const |
Returns the RenderQueue ID you told us you reserved for storing our internal objects. More... | |
uint32 | getProxyReservedVisibilityMask (void) const |
Returns the visibility mask you told us you reserved for storing our internal objects. More... | |
SceneNode *const * | getProxySceneNodes (void) const |
SceneManager * | getSceneManager (void) const |
bool | operator() (const IdObject *left, const IdObject *right) |
bool | operator() (const IdObject &left, const IdObject &right) |
virtual void | passEarlyPreExecute (CompositorPass *pass) |
Called early on in pass' execution. More... | |
virtual void | passPosExecute (CompositorPass *pass) |
Called after a pass has been executed. More... | |
virtual void | passPreExecute (CompositorPass *pass) |
Called when each pass is about to be executed. More... | |
void | releaseTmpRtt (const TexturePtr &tmpRtt) |
void | setEnabled (bool bEnabled, uint32 maxWidth, uint32 maxHeight, PixelFormat pixelFormat) |
Enables/disables this ParallaxCorrectedCubemap system. More... | |
void | setUpdatedTrackedDataFromCamera (Camera *trackedCamera) |
Will update both mTrackedPosition & mTrackedViewProjMatrix with appropiate settings every time it's called. More... | |
void | updateAllDirtyProbes (void) |
By default the probes will be constructed when the user enters its vecinity. More... | |
virtual void | workspacePreUpdate (CompositorWorkspace *workspace) |
Called before all nodes are going to be updated. More... | |
Static Public Member Functions | |
static size_t | getConstBufferSize (void) |
Public Attributes | |
uint32 | mMask |
bool | mPaused |
Vector3 | mTrackedPosition |
This variable should be updated every frame and often represents the camera position, but it can also be used set to other things like the player's character position. More... | |
Matrix4 | mTrackedViewProjMatrix |
When mTrackedPosition is not inside any probe, we'll use the view-projection matrix to select the closest probe based on which one has approximately the largest volume shown on camera. More... | |
Ogre::ParallaxCorrectedCubemap::ParallaxCorrectedCubemap | ( | IdType | id, |
Root * | root, | ||
SceneManager * | sceneManager, | ||
const CompositorWorkspaceDef * | probeWorkspaceDef, | ||
uint8 | reservedRqId, | ||
uint32 | proxyVisibilityMask | ||
) |
Ogre::ParallaxCorrectedCubemap::~ParallaxCorrectedCubemap | ( | ) |
void Ogre::ParallaxCorrectedCubemap::_addManuallyActiveProbe | ( | CubemapProbe * | probe | ) |
void Ogre::ParallaxCorrectedCubemap::_notifyPreparePassHash | ( | const Matrix4 & | viewMatrix | ) |
void Ogre::ParallaxCorrectedCubemap::_removeManuallyActiveProbe | ( | CubemapProbe * | probe | ) |
|
virtual |
Called from CompositorManager2 (not CompositorWorkspace) when we're about to begin updating all the workspaces.
You'll have to manage the RenderSystem and SceneManager to call the adequate begin/end calls Warning: Don't add/remove listeners to CompositorManager2 inside this function.
Reimplemented from Ogre::CompositorWorkspaceListener.
|
virtual |
Called from CompositorManager2 (not CompositorWorkspace) when we're about to update all the workspaces (it's safe to update your own workspaces without calling _beginUpdate and _endUpdate) Warning: Don't add/remove listeners to CompositorManager2 inside this function.
Reimplemented from Ogre::CompositorWorkspaceListener.
CubemapProbe* Ogre::ParallaxCorrectedCubemap::createProbe | ( | void | ) |
Adds a cubemap probe.
void Ogre::ParallaxCorrectedCubemap::createProxyItems | ( | void | ) |
Creates the Proxy Items.
Useful if you need to call sceneManager->clearScene(); See destroyProxyItems.
void Ogre::ParallaxCorrectedCubemap::destroyAllProbes | ( | void | ) |
void Ogre::ParallaxCorrectedCubemap::destroyProbe | ( | CubemapProbe * | probe | ) |
void Ogre::ParallaxCorrectedCubemap::destroyProxyItems | ( | void | ) |
Destroys the Proxy Items.
Useful if you need to call sceneManager->clearScene(); The you MUST call this function before. i.e. pcc->destroyProxyItems(); sceneManager->clearScene(); pcc->createProxyItems(); Updating ParallaxCorrectedCubemap without calling createProxyItems again will result in a crash.
void Ogre::ParallaxCorrectedCubemap::fillConstBufferData | ( | const Matrix4 & | viewMatrix, |
float *RESTRICT_ALIAS | passBufferPtr | ||
) | const |
void Ogre::ParallaxCorrectedCubemap::fillConstBufferData | ( | const CubemapProbe & | probe, |
const Matrix4 & | viewMatrix, | ||
const Matrix3 & | invViewMat3, | ||
float *RESTRICT_ALIAS | passBufferPtr | ||
) | const |
TexturePtr Ogre::ParallaxCorrectedCubemap::findTmpRtt | ( | const TexturePtr & | baseParams | ) |
See mTmpRtt.
Finds an RTT that is compatible to copy to baseParams. Creates one if none found.
|
inlinevirtualinherited |
Called just after a frame has been rendered.
Reimplemented in Ogre::FrameTimeControllerValue.
|
inlinevirtualinherited |
Called after all render targets have had their rendering commands issued, but before render windows have been asked to flip their buffers over.
|
virtual |
Called when a frame is about to begin rendering.
Reimplemented from Ogre::FrameListener.
|
inline |
|
inline |
|
static |
const CompositorWorkspaceDef* Ogre::ParallaxCorrectedCubemap::getDefaultWorkspaceDef | ( | void | ) | const |
bool Ogre::ParallaxCorrectedCubemap::getEnabled | ( | void | ) | const |
|
inlineinherited |
Get the unique id of this object.
|
inline |
|
inline |
References RESTRICT_ALIAS.
|
inline |
|
inline |
Returns the RenderQueue ID you told us you reserved for storing our internal objects.
Do not attempt to render the objects that match in that Rq ID & visibility mask.
|
inline |
Returns the visibility mask you told us you reserved for storing our internal objects.
Do not attempt to render the objects that match in that Rq ID & visibility mask.
|
inline |
SceneManager* Ogre::ParallaxCorrectedCubemap::getSceneManager | ( | void | ) | const |
|
inlinevirtualinherited |
Called early on in pass' execution.
Happens before passPreExecute, before the pass has set anything. Warning: calling pass->execute can result in recursive calls.
|
inlinevirtualinherited |
Called after a pass has been executed.
Warning: calling pass->execute can result in recursive calls.
|
virtual |
Called when each pass is about to be executed.
Warning: calling pass->execute can result in recursive calls.
Reimplemented from Ogre::CompositorWorkspaceListener.
void Ogre::ParallaxCorrectedCubemap::releaseTmpRtt | ( | const TexturePtr & | tmpRtt | ) |
void Ogre::ParallaxCorrectedCubemap::setEnabled | ( | bool | bEnabled, |
uint32 | maxWidth, | ||
uint32 | maxHeight, | ||
PixelFormat | pixelFormat | ||
) |
Enables/disables this ParallaxCorrectedCubemap system.
It will (de)allocate some resources, thus it may cause stalls. If you need to temporarily pause the system (or toggle at high frequency) use mPaused instead (it's a public variable).
bEnabled | True to enable. False to disable. When false, the rest of the arguments are ignored. |
maxWidth | This system allows probes to be of different resolution. The final merge must have a particular resolution though. This setting defines that value. If there's a probe that has a bigger resolution than this, then you'll be wasting memory and power on that probe. In other words, no probe should have a higher res than this setting. |
maxHeight | See maxHeight. |
pixelFormat | PixelFormat of the final blended/merged cubemap. |
void Ogre::ParallaxCorrectedCubemap::setUpdatedTrackedDataFromCamera | ( | Camera * | trackedCamera | ) |
Will update both mTrackedPosition & mTrackedViewProjMatrix with appropiate settings every time it's called.
Must be called every time the camera changes.
trackedCamera | Camera whose settings to use as reference. We will not keep a reference to this pointer. |
void Ogre::ParallaxCorrectedCubemap::updateAllDirtyProbes | ( | void | ) |
By default the probes will be constructed when the user enters its vecinity.
This can cause noticeable stalls. Use this function to regenerate them all at once (i.e. at loading time)
|
inlinevirtualinherited |
Called before all nodes are going to be updated.
Use this place to update your own, manually updated Workspaces without having to call ::_beginUpdate( forceBeginFrame=true )
uint32 Ogre::ParallaxCorrectedCubemap::mMask |
bool Ogre::ParallaxCorrectedCubemap::mPaused |
Vector3 Ogre::ParallaxCorrectedCubemap::mTrackedPosition |
This variable should be updated every frame and often represents the camera position, but it can also be used set to other things like the player's character position.
Matrix4 Ogre::ParallaxCorrectedCubemap::mTrackedViewProjMatrix |
When mTrackedPosition is not inside any probe, we'll use the view-projection matrix to select the closest probe based on which one has approximately the largest volume shown on camera.
See setUpdatedTrackedDataFromCamera if you don't know how to set this