OGRE: OgreShadowCaster.h Source File - OGRE Documentation

# OgreShadowCaster.h

Go to the documentation of this file.

    00001 /*
    00002 -----------------------------------------------------------------------------
    00003 This source file is part of OGRE
    00004     (Object-oriented Graphics Rendering Engine)
    00005 For the latest info, see http://www.ogre3d.org/
    00006
    00007 Copyright (c) 2000-2009 Torus Knot Software Ltd
    00008
    00009 Permission is hereby granted, free of charge, to any person obtaining a copy
    00010 of this software and associated documentation files (the "Software"), to deal
    00011 in the Software without restriction, including without limitation the rights
    00012 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    00013 copies of the Software, and to permit persons to whom the Software is
    00014 furnished to do so, subject to the following conditions:
    00015
    00016 The above copyright notice and this permission notice shall be included in
    00017 all copies or substantial portions of the Software.
    00018
    00019 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    00020 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    00021 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    00022 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    00023 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    00024 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    00025 THE SOFTWARE.
    00026 -----------------------------------------------------------------------------
    00027 */
    00028 #ifndef __ShadowCaster_H__
    00029 #define __ShadowCaster_H__
    00030
    00031 #include "OgrePrerequisites.h"
    00032 #include "OgreRenderable.h"
    00033
    00034
    00035 namespace Ogre {
    00036
    00037
    00052     class _OgreExport ShadowRenderable : public Renderable, public ShadowDataAlloc
    00053     {
    00054     protected:
    00055         MaterialPtr mMaterial;
    00056         RenderOperation mRenderOp;
    00057         ShadowRenderable* mLightCap; // used only if isLightCapSeparate == true
    00058     public:
    00059         ShadowRenderable() : mMaterial(), mLightCap(0) {}
    00060         virtual ~ShadowRenderable() { delete mLightCap; }
    00064         void setMaterial(const MaterialPtr& mat) { mMaterial = mat; }
    00066         const MaterialPtr& getMaterial(void) const { return mMaterial; }
    00068         void getRenderOperation(RenderOperation& op) { op = mRenderOp; }
    00070         RenderOperation* getRenderOperationForUpdate(void) {return &mRenderOp;}
    00072         void getWorldTransforms(Matrix4* xform) const = 0;
    00074         Real getSquaredViewDepth(const Camera*) const{ return 0; /* not used */}
    00076         const LightList& getLights(void) const;
    00087         bool isLightCapSeparate(void) const { return mLightCap != 0; }
    00088
    00090         ShadowRenderable* getLightCapRenderable(void) { return mLightCap; }
    00092         virtual bool isVisible(void) const { return true; }
    00093
    00094     };
    00095
    00097     enum ShadowRenderableFlags
    00098     {
    00100         SRF_INCLUDE_LIGHT_CAP = 0x00000001,
    00102         SRF_INCLUDE_DARK_CAP  = 0x00000002,
    00104         SRF_EXTRUDE_TO_INFINITY  = 0x00000004
    00105     };
    00106
    00109     class _OgreExport ShadowCaster
    00110     {
    00111     public:
    00112         virtual ~ShadowCaster() { }
    00114         virtual bool getCastShadows(void) const = 0;
    00115
    00117         virtual EdgeData* getEdgeList(void) = 0;
    00119         virtual bool hasEdgeList(void) = 0;
    00120
    00122         virtual const AxisAlignedBox& getWorldBoundingBox(bool derive = false) const = 0;
    00124         virtual const AxisAlignedBox& getLightCapBounds(void) const = 0;
    00126         virtual const AxisAlignedBox& getDarkCapBounds(const Light& light, Real dirLightExtrusionDist) const = 0;
    00127
    00128         typedef vector<ShadowRenderable*>::type ShadowRenderableList;
    00129         typedef VectorIterator<ShadowRenderableList> ShadowRenderableListIterator;
    00130
    00146         virtual ShadowRenderableListIterator getShadowVolumeRenderableIterator(
    00147             ShadowTechnique shadowTechnique, const Light* light,
    00148             HardwareIndexBufferSharedPtr* indexBuffer,
    00149             bool extrudeVertices, Real extrusionDistance, unsigned long flags = 0 ) = 0;
    00150
    00170         static void extrudeVertices(const HardwareVertexBufferSharedPtr& vertexBuffer,
    00171             size_t originalVertexCount, const Vector4& lightPos, Real extrudeDist);
    00173         virtual Real getPointExtrusionDistance(const Light* l) const = 0;
    00174     protected:
    00176         Real getExtrusionDistance(const Vector3& objectPos, const Light* light) const;
    00184         virtual void updateEdgeListLightFacing(EdgeData* edgeData,
    00185             const Vector4& lightPos);
    00186
    00200         virtual void generateShadowVolume(EdgeData* edgeData,
    00201             const HardwareIndexBufferSharedPtr& indexBuffer, const Light* light,
    00202             ShadowRenderableList& shadowRenderables, unsigned long flags);
    00209         virtual void extrudeBounds(AxisAlignedBox& box, const Vector4& lightPos,
    00210             Real extrudeDist) const;
    00211
    00212
    00213     };
    00216 }
    00217
    00218 #endif

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Nov 3 2010 19:24:52