A surface which is defined by curves of some kind to form a patch, e.g. More...
#include <OgrePatchSurface.h>
Public Types | |
enum | { AUTO_LEVEL = -1 } |
Constant for indicating automatic determination of subdivision level for patches. More... | |
enum | PatchSurfaceType { PST_BEZIER } |
enum | VisibleSide { VS_FRONT, VS_BACK, VS_BOTH } |
Public Member Functions | |
PatchSurface () | |
~PatchSurface () | |
void | build (HardwareVertexBufferSharedPtr destVertexBuffer, size_t vertexStart, HardwareIndexBufferSharedPtr destIndexBuffer, size_t indexStart) |
Tells the system to build the mesh relating to the surface into externally created buffers. More... | |
void | defineSurface (void *controlPointBuffer, VertexDeclaration *declaration, size_t width, size_t height, PatchSurfaceType pType=PST_BEZIER, size_t uMaxSubdivisionLevel=AUTO_LEVEL, size_t vMaxSubdivisionLevel=AUTO_LEVEL, VisibleSide visibleSide=VS_FRONT) |
Sets up the surface by defining it's control points, type and initial subdivision level. More... | |
Real | getBoundingSphereRadius (void) const |
Gets the radius of the bounding sphere for this patch, only valid after defineSurface has been called. More... | |
const AxisAlignedBox & | getBounds (void) const |
Gets the bounds of this patch, only valid after calling defineSurface. More... | |
void * | getControlPointBuffer (void) const |
size_t | getCurrentIndexCount (void) const |
Gets the current index count based on the current subdivision level. More... | |
size_t | getIndexOffset (void) const |
Returns the index offset used by this buffer to write data into the buffer. More... | |
size_t | getRequiredIndexCount (void) const |
Based on a previous call to defineSurface, establishes the number of indexes required to hold this patch at the maximum detail level. More... | |
size_t | getRequiredVertexCount (void) const |
Based on a previous call to defineSurface, establishes the number of vertices required to hold this patch at the maximum detail level. More... | |
Real | getSubdivisionFactor (void) const |
Gets the current level of subdivision. More... | |
size_t | getVertexOffset (void) const |
Returns the vertex offset used by this buffer to write data into the buffer. More... | |
void | notifyControlPointBufferDeallocated (void) |
Convenience method for telling the patch that the control points have been deleted, since once the patch has been built they are not required. More... | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, void *) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz, const char *file, int line, const char *func) |
operator new, with debug line info More... | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *ptr) |
placement operator new More... | |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info More... | |
void * | operator new[] (size_t sz) |
void | setSubdivisionFactor (Real factor) |
Alters the level of subdivision for this surface. More... | |
Protected Member Functions | |
void | distributeControlPoints (void *lockedBuffer) |
size_t | findLevel (Vector3 &a, Vector3 &b, Vector3 &c) |
Internal method for finding the subdivision level given 3 control points. More... | |
size_t | getAutoULevel (bool forMax=false) |
size_t | getAutoVLevel (bool forMax=false) |
void | interpolateVertexData (void *lockedBuffer, size_t leftIndex, size_t rightIndex, size_t destIndex) |
void | makeTriangles (void) |
void | subdivideCurve (void *lockedBuffer, size_t startIdx, size_t stepSize, size_t numSteps, size_t iterations) |
Protected Attributes | |
AxisAlignedBox | mAABB |
Real | mBoundingSphere |
void * | mControlPointBuffer |
Buffer containing the system-memory control points. More... | |
size_t | mCtlCount |
TotalNumber of control points. More... | |
size_t | mCtlHeight |
Height in control points. More... | |
size_t | mCtlWidth |
Width in control points. More... | |
size_t | mCurrIndexCount |
VertexDeclaration * | mDeclaration |
Vertex declaration describing the control point buffer. More... | |
HardwareIndexBufferSharedPtr | mIndexBuffer |
size_t | mIndexOffset |
size_t | mMaxULevel |
Max subdivision level. More... | |
size_t | mMaxVLevel |
size_t | mMeshHeight |
Height of the subdivided mesh (big enough for max level) More... | |
size_t | mMeshWidth |
Width of the subdivided mesh (big enough for max level) More... | |
size_t | mRequiredIndexCount |
size_t | mRequiredVertexCount |
Real | mSubdivisionFactor |
PatchSurfaceType | mType |
Type of surface. More... | |
size_t | mULevel |
U-direction subdivision level. More... | |
vector< Vector3 >::type | mVecCtlPoints |
HardwareVertexBufferSharedPtr | mVertexBuffer |
size_t | mVertexOffset |
size_t | mVLevel |
V-direction subdivision level. More... | |
VisibleSide | mVSide |
Which side is visible. More... | |
A surface which is defined by curves of some kind to form a patch, e.g.
a Bezier patch.
Definition at line 53 of file OgrePatchSurface.h.
anonymous enum |
Constant for indicating automatic determination of subdivision level for patches.
Enumerator | |
---|---|
AUTO_LEVEL |
Definition at line 66 of file OgrePatchSurface.h.
Enumerator | |
---|---|
PST_BEZIER |
A patch defined by a set of bezier curves. |
Definition at line 59 of file OgrePatchSurface.h.
Definition at line 71 of file OgrePatchSurface.h.
Ogre::PatchSurface::PatchSurface | ( | ) |
Ogre::PatchSurface::~PatchSurface | ( | ) |
void Ogre::PatchSurface::build | ( | HardwareVertexBufferSharedPtr | destVertexBuffer, |
size_t | vertexStart, | ||
HardwareIndexBufferSharedPtr | destIndexBuffer, | ||
size_t | indexStart | ||
) |
Tells the system to build the mesh relating to the surface into externally created buffers.
destVertexBuffer | The destination vertex buffer in which to build the patch. |
vertexStart | The offset at which to start writing vertices for this patch |
destIndexBuffer | The destination index buffer in which to build the patch. |
indexStart | The offset at which to start writing indexes for this patch |
void Ogre::PatchSurface::defineSurface | ( | void * | controlPointBuffer, |
VertexDeclaration * | declaration, | ||
size_t | width, | ||
size_t | height, | ||
PatchSurfaceType | pType = PST_BEZIER , |
||
size_t | uMaxSubdivisionLevel = AUTO_LEVEL , |
||
size_t | vMaxSubdivisionLevel = AUTO_LEVEL , |
||
VisibleSide | visibleSide = VS_FRONT |
||
) |
Sets up the surface by defining it's control points, type and initial subdivision level.
controlPointBuffer | A pointer to a buffer containing the vertex data which defines control points of the curves rather than actual vertices. Note that you are expected to provide not just position information, but potentially normals and texture coordinates too. The format of the buffer is defined in the VertexDeclaration parameter |
declaration | VertexDeclaration describing the contents of the buffer. Note this declaration must only draw on buffer source 0! |
width | Specifies the width of the patch in control points. |
height | Specifies the height of the patch in control points. |
pType | The type of surface - currently only PST_BEZIER is supported |
uMaxSubdivisionLevel,vMaxSubdivisionLevel | If you want to manually set the top level of subdivision, do it here, otherwise let the system decide. |
visibleSide | Determines which side of the patch (or both) triangles are generated for. |
|
protected |
Internal method for finding the subdivision level given 3 control points.
|
protected |
|
protected |
Real Ogre::PatchSurface::getBoundingSphereRadius | ( | void | ) | const |
Gets the radius of the bounding sphere for this patch, only valid after defineSurface has been called.
const AxisAlignedBox& Ogre::PatchSurface::getBounds | ( | void | ) | const |
Gets the bounds of this patch, only valid after calling defineSurface.
|
inline |
Definition at line 169 of file OgrePatchSurface.h.
size_t Ogre::PatchSurface::getCurrentIndexCount | ( | void | ) | const |
Gets the current index count based on the current subdivision level.
|
inline |
Returns the index offset used by this buffer to write data into the buffer.
Definition at line 128 of file OgrePatchSurface.h.
size_t Ogre::PatchSurface::getRequiredIndexCount | ( | void | ) | const |
Based on a previous call to defineSurface, establishes the number of indexes required to hold this patch at the maximum detail level.
size_t Ogre::PatchSurface::getRequiredVertexCount | ( | void | ) | const |
Based on a previous call to defineSurface, establishes the number of vertices required to hold this patch at the maximum detail level.
Real Ogre::PatchSurface::getSubdivisionFactor | ( | void | ) | const |
Gets the current level of subdivision.
|
inline |
Returns the vertex offset used by this buffer to write data into the buffer.
Definition at line 130 of file OgrePatchSurface.h.
|
protected |
|
protected |
|
inline |
Convenience method for telling the patch that the control points have been deleted, since once the patch has been built they are not required.
Definition at line 175 of file OgrePatchSurface.h.
|
inlineinherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
void Ogre::PatchSurface::setSubdivisionFactor | ( | Real | factor | ) |
Alters the level of subdivision for this surface.
|
protected |
|
protected |
Definition at line 229 of file OgrePatchSurface.h.
|
protected |
Definition at line 230 of file OgrePatchSurface.h.
|
protected |
Buffer containing the system-memory control points.
Definition at line 182 of file OgrePatchSurface.h.
|
protected |
TotalNumber of control points.
Definition at line 190 of file OgrePatchSurface.h.
|
protected |
Height in control points.
Definition at line 188 of file OgrePatchSurface.h.
|
protected |
Width in control points.
Definition at line 186 of file OgrePatchSurface.h.
|
protected |
Definition at line 227 of file OgrePatchSurface.h.
|
protected |
Vertex declaration describing the control point buffer.
Definition at line 180 of file OgrePatchSurface.h.
|
protected |
Definition at line 222 of file OgrePatchSurface.h.
|
protected |
Definition at line 224 of file OgrePatchSurface.h.
|
protected |
Max subdivision level.
Definition at line 196 of file OgrePatchSurface.h.
|
protected |
Definition at line 197 of file OgrePatchSurface.h.
|
protected |
Height of the subdivided mesh (big enough for max level)
Definition at line 201 of file OgrePatchSurface.h.
|
protected |
Width of the subdivided mesh (big enough for max level)
Definition at line 199 of file OgrePatchSurface.h.
|
protected |
Definition at line 226 of file OgrePatchSurface.h.
|
protected |
Definition at line 225 of file OgrePatchSurface.h.
|
protected |
Definition at line 205 of file OgrePatchSurface.h.
|
protected |
Type of surface.
Definition at line 184 of file OgrePatchSurface.h.
|
protected |
U-direction subdivision level.
Definition at line 192 of file OgrePatchSurface.h.
Definition at line 207 of file OgrePatchSurface.h.
|
protected |
Definition at line 221 of file OgrePatchSurface.h.
|
protected |
Definition at line 223 of file OgrePatchSurface.h.
|
protected |
V-direction subdivision level.
Definition at line 194 of file OgrePatchSurface.h.
|
protected |
Which side is visible.
Definition at line 203 of file OgrePatchSurface.h.