Nirtcpp 2.1.0
Nirtcpp is a high-performance c++ graphics engine.
Loading...
Searching...
No Matches
nirt::scene::IMeshManipulator Class Referenceabstract

An interface for easy manipulation of meshes. More...

#include <nirtcpp/core/engine/IMeshManipulator.hpp>

Inheritance diagram for nirt::scene::IMeshManipulator:
Inheritance graph
Collaboration diagram for nirt::scene::IMeshManipulator:
Collaboration graph

Public Member Functions

virtual void flipSurfaces (IMesh *mesh) const =0
 Flips the direction of surfaces.
 
void setVertexColorAlpha (IMesh *mesh, s32 alpha) const
 Sets the alpha vertex color value of the whole mesh to a new value.
 
void setVertexColorAlpha (IMeshBuffer *buffer, s32 alpha) const
 Sets the alpha vertex color value of the whole mesh to a new value.
 
void setVertexColors (IMesh *mesh, video::SColor color) const
 Sets the colors of all vertices to one color.
 
void setVertexColors (IMeshBuffer *buffer, video::SColor color) const
 Sets the colors of all vertices to one color.
 
virtual void recalculateNormals (IMesh *mesh, bool smooth=false, bool angleWeighted=false) const =0
 Recalculates all normals of the mesh.
 
virtual void recalculateNormals (IMeshBuffer *buffer, bool smooth=false, bool angleWeighted=false) const =0
 Recalculates all normals of the mesh buffer.
 
virtual void recalculateTangents (IMesh *mesh, bool recalculateNormals=false, bool smooth=false, bool angleWeighted=false) const =0
 Recalculates tangents, requires a tangent mesh.
 
virtual void recalculateTangents (IMeshBuffer *buffer, bool recalculateNormals=false, bool smooth=false, bool angleWeighted=false) const =0
 Recalculates tangents, requires a tangent mesh buffer.
 
void scale (IMesh *mesh, const core::vector3df &factor) const
 Scales the actual mesh, not a scene node.
 
void scale (IMeshBuffer *buffer, const core::vector3df &factor) const
 Scales the actual meshbuffer, not a scene node.
 
NIRT_DEPRECATED void scaleMesh (IMesh *mesh, const core::vector3df &factor) const
 Scales the actual mesh, not a scene node.
 
void scaleTCoords (scene::IMesh *mesh, const core::vector2df &factor, u32 level=1) const
 Scale the texture coords of a mesh.
 
void scaleTCoords (scene::IMeshBuffer *buffer, const core::vector2df &factor, u32 level=1) const
 Scale the texture coords of a meshbuffer.
 
void transform (IMesh *mesh, const core::matrix4 &m, u32 normalsUpdate=0, bool normalizeNormals=false) const
 Applies a transformation to a mesh.
 
void transform (IMeshBuffer *buffer, const core::matrix4 &m, u32 normalsUpdate=0, bool normalizeNormals=false) const
 Applies a transformation to a meshbuffer.
 
virtual NIRT_DEPRECATED void transformMesh (IMesh *mesh, const core::matrix4 &m) const
 Applies a transformation to a mesh.
 
virtual void makePlanarTextureMapping (IMesh *mesh, f32 resolution=0.001f) const =0
 Creates a planar texture mapping on the mesh.
 
virtual void makePlanarTextureMapping (scene::IMeshBuffer *meshbuffer, f32 resolution=0.001f) const =0
 Creates a planar texture mapping on the meshbuffer.
 
virtual void makePlanarTextureMapping (scene::IMesh *mesh, f32 resolutionS, f32 resolutionT, u8 axis, const core::vector3df &offset) const =0
 Creates a planar texture mapping on the buffer.
 
virtual void makePlanarTextureMapping (scene::IMeshBuffer *buffer, f32 resolutionS, f32 resolutionT, u8 axis, const core::vector3df &offset) const =0
 Creates a planar texture mapping on the meshbuffer.
 
virtual SMeshcreateMeshCopy (IMesh *mesh) const =0
 Clones a static IMesh into a modifiable SMesh.
 
virtual IMeshcreateMeshWithTangents (IMesh *mesh, bool recalculateNormals=false, bool smooth=false, bool angleWeighted=false, bool recalculateTangents=true) const =0
 Creates a copy of the mesh, which will only consist of S3DVertexTangents vertices.
 
virtual IMeshcreateMeshWith2TCoords (IMesh *mesh) const =0
 Creates a copy of the mesh, which will only consist of S3DVertex2TCoord vertices.
 
virtual IMeshcreateMeshWith1TCoords (IMesh *mesh) const =0
 Creates a copy of the mesh, which will only consist of S3DVertex vertices.
 
virtual IMeshcreateMeshUniquePrimitives (IMesh *mesh) const =0
 Creates a copy of a mesh with all vertices unwelded.
 
virtual IMeshcreateMeshWelded (IMesh *mesh, f32 tolerance=core::ROUNDING_ERROR_f32) const =0
 Creates a copy of a mesh with vertices welded.
 
virtual s32 getPolyCount (IMesh *mesh) const =0
 Get amount of polygons in mesh.
 
virtual s32 getPolyCount (IAnimatedMesh *mesh) const =0
 Get amount of polygons in mesh.
 
virtual IAnimatedMeshcreateAnimatedMesh (IMesh *mesh, scene::E_ANIMATED_MESH_TYPE type=scene::EAMT_UNKNOWN) const =0
 Create a new AnimatedMesh and adds the mesh to it.
 
virtual IMeshcreateForsythOptimizedMesh (const IMesh *mesh) const =0
 Vertex cache optimization according to the Forsyth paper.
 
virtual void heightmapOptimizeMesh (IMesh *const mesh, const f32 tolerance=core::ROUNDING_ERROR_f32) const =0
 Optimize the mesh with an algorithm tuned for heightmaps.
 
virtual void heightmapOptimizeMesh (IMeshBuffer *const mb, const f32 tolerance=core::ROUNDING_ERROR_f32) const =0
 Optimize the meshbuffer with an algorithm tuned for heightmaps.
 
template<typename Functor >
bool apply (const Functor &func, IMeshBuffer *buffer, bool boundingBoxUpdate=false) const
 Apply a manipulator on the Meshbuffer.
 
template<typename Functor >
bool apply (const Functor &func, IMesh *mesh, bool boundingBoxUpdate=false) const
 Apply a manipulator on the Mesh.
 
- Public Member Functions inherited from nirt::IReferenceCounted
 IReferenceCounted ()
 Constructor.
 
virtual ~IReferenceCounted ()
 Destructor.
 
void grab () const
 Grabs the object. Increments the reference counter by one.
 
bool drop () const
 Drops the object. Decrements the reference counter by one.
 
s32 getReferenceCount () const
 Get the reference count.
 
const c8getDebugName () const
 Returns the debug name of the object.
 

Protected Member Functions

template<typename Functor >
bool apply_ (const Functor &func, IMeshBuffer *buffer, bool boundingBoxUpdate, const IVertexManipulator &typeTest) const
 Apply a manipulator based on the type of the functor.
 
- Protected Member Functions inherited from nirt::IReferenceCounted
void setDebugName (const c8 *newName)
 Sets the debug name of the object.
 

Detailed Description

An interface for easy manipulation of meshes.

Scale, set alpha value, flip surfaces, and so on. This exists for fixing problems with wrong imported or exported meshes quickly after loading. It is not intended for doing mesh modifications and/or animations during runtime.

Member Function Documentation

◆ apply() [1/2]

template<typename Functor >
bool nirt::scene::IMeshManipulator::apply ( const Functor &  func,
IMesh mesh,
bool  boundingBoxUpdate = false 
) const
inline

Apply a manipulator on the Mesh.

Parameters
funcA functor defining the mesh manipulation.
meshThe Mesh to apply the manipulator to.
boundingBoxUpdateSpecifies if the bounding box should be updated during manipulation.
Returns
True if the functor was successfully applied, else false.

◆ apply() [2/2]

template<typename Functor >
bool nirt::scene::IMeshManipulator::apply ( const Functor &  func,
IMeshBuffer buffer,
bool  boundingBoxUpdate = false 
) const
inline

Apply a manipulator on the Meshbuffer.

Parameters
funcA functor defining the mesh manipulation.
bufferThe Meshbuffer to apply the manipulator to.
boundingBoxUpdateSpecifies if the bounding box should be updated during manipulation.
Returns
True if the functor was successfully applied, else false.

◆ apply_()

template<typename Functor >
bool nirt::scene::IMeshManipulator::apply_ ( const Functor &  func,
IMeshBuffer buffer,
bool  boundingBoxUpdate,
const IVertexManipulator typeTest 
) const
inlineprotected

Apply a manipulator based on the type of the functor.

Parameters
funcA functor defining the mesh manipulation.
bufferThe Meshbuffer to apply the manipulator to.
boundingBoxUpdateSpecifies if the bounding box should be updated during manipulation.
typeTestUnused parameter, which handles the proper call selection based on the type of the Functor which is passed in two times.
Returns
True if the functor was successfully applied, else false.

◆ createAnimatedMesh()

virtual IAnimatedMesh * nirt::scene::IMeshManipulator::createAnimatedMesh ( IMesh mesh,
scene::E_ANIMATED_MESH_TYPE  type = scene::EAMT_UNKNOWN 
) const
pure virtual

Create a new AnimatedMesh and adds the mesh to it.

Parameters
meshInput mesh
typeThe type of the animated mesh to create.
Returns
Newly created animated mesh with mesh as its only content. When you don't need the animated mesh anymore, you should call IAnimatedMesh::drop(). See IReferenceCounted::drop() for more information.

◆ createForsythOptimizedMesh()

virtual IMesh * nirt::scene::IMeshManipulator::createForsythOptimizedMesh ( const IMesh mesh) const
pure virtual

Vertex cache optimization according to the Forsyth paper.

More information can be found at http://home.comcast.net/~tom_forsyth/papers/fast_vert_cache_opt.html

The function is thread-safe (read: you can optimize several meshes in different threads).

Parameters
meshSource mesh for the operation.
Returns
A new mesh optimized for the vertex cache.

◆ createMeshCopy()

virtual SMesh * nirt::scene::IMeshManipulator::createMeshCopy ( IMesh mesh) const
pure virtual

Clones a static IMesh into a modifiable SMesh.

Parameters
meshMesh to copy.
Returns
Cloned mesh. If you no longer need the cloned mesh, you should call SMesh::drop(). See IReferenceCounted::drop() for more information.

◆ createMeshUniquePrimitives()

virtual IMesh * nirt::scene::IMeshManipulator::createMeshUniquePrimitives ( IMesh mesh) const
pure virtual

Creates a copy of a mesh with all vertices unwelded.

Note: Only 16-bit meshbuffers supported so far

Parameters
meshInput mesh
Returns
Mesh consisting only of unique faces. All vertices which were previously shared are now duplicated. If you no longer need the cloned mesh, you should call IMesh::drop(). See IReferenceCounted::drop() for more information.

◆ createMeshWelded()

virtual IMesh * nirt::scene::IMeshManipulator::createMeshWelded ( IMesh mesh,
f32  tolerance = core::ROUNDING_ERROR_f32 
) const
pure virtual

Creates a copy of a mesh with vertices welded.

Note: Only 16-bit meshbuffers supported so far, 32-bit buffer are cloned

Parameters
meshInput mesh
toleranceThe threshold for vertex comparisons.
Returns
Mesh without redundant vertices. If you no longer need the cloned mesh, you should call IMesh::drop(). See IReferenceCounted::drop() for more information.

◆ createMeshWith1TCoords()

virtual IMesh * nirt::scene::IMeshManipulator::createMeshWith1TCoords ( IMesh mesh) const
pure virtual

Creates a copy of the mesh, which will only consist of S3DVertex vertices.

Note: Only 16-bit meshbuffers supported so far

Parameters
meshInput mesh
Returns
Mesh consisting only of S3DVertex vertices. If you no longer need the cloned mesh, you should call IMesh::drop(). See IReferenceCounted::drop() for more information.

◆ createMeshWith2TCoords()

virtual IMesh * nirt::scene::IMeshManipulator::createMeshWith2TCoords ( IMesh mesh) const
pure virtual

Creates a copy of the mesh, which will only consist of S3DVertex2TCoord vertices.

Note: Only 16-bit meshbuffers supported so far

Parameters
meshInput mesh
Returns
Mesh consisting only of S3DVertex2TCoord vertices. If you no longer need the cloned mesh, you should call IMesh::drop(). See IReferenceCounted::drop() for more information.

◆ createMeshWithTangents()

virtual IMesh * nirt::scene::IMeshManipulator::createMeshWithTangents ( IMesh mesh,
bool  recalculateNormals = false,
bool  smooth = false,
bool  angleWeighted = false,
bool  recalculateTangents = true 
) const
pure virtual

Creates a copy of the mesh, which will only consist of S3DVertexTangents vertices.

This is useful if you want to draw tangent space normal mapped geometry because it calculates the tangent and binormal data which is needed there. Note: Only 16-bit meshbuffers supported so far

Parameters
meshInput mesh
recalculateNormalsThe normals are recalculated if set, otherwise the original ones are kept. Note that keeping the normals may introduce inaccurate tangents if the normals are very different to those calculated from the faces.
smoothThe normals/tangents are smoothed across the meshbuffer's faces if this flag is set.
angleWeightedImproved smoothing calculation used
recalculateTangentsWhether are actually calculated, or just the mesh with proper type is created.
Returns
Mesh consisting only of S3DVertexTangents vertices. If you no longer need the cloned mesh, you should call IMesh::drop(). See IReferenceCounted::drop() for more information.

◆ flipSurfaces()

virtual void nirt::scene::IMeshManipulator::flipSurfaces ( IMesh mesh) const
pure virtual

Flips the direction of surfaces.

Changes backfacing triangles to frontfacing triangles and vice versa.

Parameters
meshMesh on which the operation is performed.

◆ getPolyCount() [1/2]

virtual s32 nirt::scene::IMeshManipulator::getPolyCount ( IAnimatedMesh mesh) const
pure virtual

Get amount of polygons in mesh.

Parameters
meshInput mesh
Returns
Number of polygons in mesh.

◆ getPolyCount() [2/2]

virtual s32 nirt::scene::IMeshManipulator::getPolyCount ( IMesh mesh) const
pure virtual

Get amount of polygons in mesh.

Parameters
meshInput mesh
Returns
Number of polygons in mesh.

◆ heightmapOptimizeMesh() [1/2]

virtual void nirt::scene::IMeshManipulator::heightmapOptimizeMesh ( IMesh *const  mesh,
const f32  tolerance = core::ROUNDING_ERROR_f32 
) const
pure virtual

Optimize the mesh with an algorithm tuned for heightmaps.

This differs from usual simplification methods in two ways:

  • it's intended to be lossless
  • it has special care for the borders, which are useful with heightmap tiles

This function is thread-safe. Remember to weld afterwards - this function only moves vertices, it does not weld.

Parameters
meshMesh to operate on.

◆ heightmapOptimizeMesh() [2/2]

virtual void nirt::scene::IMeshManipulator::heightmapOptimizeMesh ( IMeshBuffer *const  mb,
const f32  tolerance = core::ROUNDING_ERROR_f32 
) const
pure virtual

Optimize the meshbuffer with an algorithm tuned for heightmaps.

This differs from usual simplification methods in two ways:

  • it's intended to be lossless
  • it has special care for the borders, which are useful with heightmap tiles

This function is thread-safe. Remember to weld afterward - this function only moves vertices, it does not weld.

Parameters
mbMeshbuffer to operate on.

◆ makePlanarTextureMapping() [1/4]

virtual void nirt::scene::IMeshManipulator::makePlanarTextureMapping ( IMesh mesh,
f32  resolution = 0.001f 
) const
pure virtual

Creates a planar texture mapping on the mesh.

Parameters
meshMesh on which the operation is performed.
resolutionresolution of the planar mapping. This is the value specifying which is the relation between world space and texture coordinate space.

◆ makePlanarTextureMapping() [2/4]

virtual void nirt::scene::IMeshManipulator::makePlanarTextureMapping ( scene::IMesh mesh,
f32  resolutionS,
f32  resolutionT,
u8  axis,
const core::vector3df offset 
) const
pure virtual

Creates a planar texture mapping on the buffer.

This method is currently implemented towards the LWO planar mapping. A more general biasing might be required.

Parameters
meshMesh on which the operation is performed.
resolutionSResolution of the planar mapping in horizontal direction. This is the ratio between object space and texture space.
resolutionTResolution of the planar mapping in vertical direction. This is the ratio between object space and texture space.
axisThe axis along which the texture is projected. The allowed values are 0 (X), 1(Y), and 2(Z).
offsetVector added to the vertex positions (in object coordinates).

◆ makePlanarTextureMapping() [3/4]

virtual void nirt::scene::IMeshManipulator::makePlanarTextureMapping ( scene::IMeshBuffer buffer,
f32  resolutionS,
f32  resolutionT,
u8  axis,
const core::vector3df offset 
) const
pure virtual

Creates a planar texture mapping on the meshbuffer.

This method is currently implemented towards the LWO planar mapping. A more general biasing might be required.

Parameters
bufferBuffer on which the operation is performed.
resolutionSResolution of the planar mapping in horizontal direction. This is the ratio between object space and texture space.
resolutionTResolution of the planar mapping in vertical direction. This is the ratio between object space and texture space.
axisThe axis along which the texture is projected. The allowed values are 0 (X), 1(Y), and 2(Z).
offsetVector added to the vertex positions (in object coordinates).

◆ makePlanarTextureMapping() [4/4]

virtual void nirt::scene::IMeshManipulator::makePlanarTextureMapping ( scene::IMeshBuffer meshbuffer,
f32  resolution = 0.001f 
) const
pure virtual

Creates a planar texture mapping on the meshbuffer.

Parameters
meshbufferBuffer on which the operation is performed.
resolutionresolution of the planar mapping. This is the value specifying which is the relation between world space and texture coordinate space.

◆ recalculateNormals() [1/2]

virtual void nirt::scene::IMeshManipulator::recalculateNormals ( IMesh mesh,
bool  smooth = false,
bool  angleWeighted = false 
) const
pure virtual

Recalculates all normals of the mesh.

Parameters
meshMesh on which the operation is performed.
smoothIf the normals shall be smoothed.
angleWeightedIf the normals shall be smoothed in relation to their angles. More expensive, but also higher precision.

◆ recalculateNormals() [2/2]

virtual void nirt::scene::IMeshManipulator::recalculateNormals ( IMeshBuffer buffer,
bool  smooth = false,
bool  angleWeighted = false 
) const
pure virtual

Recalculates all normals of the mesh buffer.

Parameters
bufferMesh buffer on which the operation is performed.
smoothIf the normals shall be smoothed.
angleWeightedIf the normals shall be smoothed in relation to their angles. More expensive, but also higher precision.

◆ recalculateTangents() [1/2]

virtual void nirt::scene::IMeshManipulator::recalculateTangents ( IMesh mesh,
bool  recalculateNormals = false,
bool  smooth = false,
bool  angleWeighted = false 
) const
pure virtual

Recalculates tangents, requires a tangent mesh.

Parameters
meshMesh on which the operation is performed.
recalculateNormalsIf the normals shall be recalculated, otherwise original normals of the mesh are used unchanged.
smoothIf the normals shall be smoothed.
angleWeightedIf the normals shall be smoothed in relation to their angles. More expensive, but also higher precision.

◆ recalculateTangents() [2/2]

virtual void nirt::scene::IMeshManipulator::recalculateTangents ( IMeshBuffer buffer,
bool  recalculateNormals = false,
bool  smooth = false,
bool  angleWeighted = false 
) const
pure virtual

Recalculates tangents, requires a tangent mesh buffer.

Parameters
bufferMeshbuffer on which the operation is performed.
recalculateNormalsIf the normals shall be recalculated, otherwise original normals of the buffer are used unchanged.
smoothIf the normals shall be smoothed.
angleWeightedIf the normals shall be smoothed in relation to their angles. More expensive, but also higher precision.

◆ scale() [1/2]

void nirt::scene::IMeshManipulator::scale ( IMesh mesh,
const core::vector3df factor 
) const
inline

Scales the actual mesh, not a scene node.

Note: When your scale are not uniform then prefer the transform function to have correct normals.

Parameters
meshMesh on which the operation is performed.
factorScale factor for each axis.

◆ scale() [2/2]

void nirt::scene::IMeshManipulator::scale ( IMeshBuffer buffer,
const core::vector3df factor 
) const
inline

Scales the actual meshbuffer, not a scene node.

Note: When your scale are not uniform then prefer the transform function to have correct normals.

Parameters
bufferMeshbuffer on which the operation is performed.
factorScale factor for each axis.

◆ scaleMesh()

NIRT_DEPRECATED void nirt::scene::IMeshManipulator::scaleMesh ( IMesh mesh,
const core::vector3df factor 
) const
inline

Scales the actual mesh, not a scene node.

Deprecated:
Use scale() instead. This method may be removed by Nirtcpp 1.9
Parameters
meshMesh on which the operation is performed.
factorScale factor for each axis.

◆ scaleTCoords() [1/2]

void nirt::scene::IMeshManipulator::scaleTCoords ( scene::IMesh mesh,
const core::vector2df factor,
u32  level = 1 
) const
inline

Scale the texture coords of a mesh.

Parameters
meshMesh on which the operation is performed.
factorVector which defines the scale for each axis.
levelNumber of texture coord, starting from 1. Support for level 2 exists for LightMap buffers.

◆ scaleTCoords() [2/2]

void nirt::scene::IMeshManipulator::scaleTCoords ( scene::IMeshBuffer buffer,
const core::vector2df factor,
u32  level = 1 
) const
inline

Scale the texture coords of a meshbuffer.

Parameters
bufferMeshbuffer on which the operation is performed.
factorVector which defines the scale for each axis.
levelNumber of texture coord, starting from 1. Support for level 2 exists for LightMap buffers.

◆ setVertexColorAlpha() [1/2]

void nirt::scene::IMeshManipulator::setVertexColorAlpha ( IMesh mesh,
s32  alpha 
) const
inline

Sets the alpha vertex color value of the whole mesh to a new value.

Parameters
meshMesh on which the operation is performed.
alphaNew alpha value. Must be a value between 0 and 255.

◆ setVertexColorAlpha() [2/2]

void nirt::scene::IMeshManipulator::setVertexColorAlpha ( IMeshBuffer buffer,
s32  alpha 
) const
inline

Sets the alpha vertex color value of the whole mesh to a new value.

Parameters
bufferMeshbuffer on which the operation is performed.
alphaNew alpha value. Must be a value between 0 and 255.

◆ setVertexColors() [1/2]

void nirt::scene::IMeshManipulator::setVertexColors ( IMesh mesh,
video::SColor  color 
) const
inline

Sets the colors of all vertices to one color.

Parameters
meshMesh on which the operation is performed.
colorNew color.

◆ setVertexColors() [2/2]

void nirt::scene::IMeshManipulator::setVertexColors ( IMeshBuffer buffer,
video::SColor  color 
) const
inline

Sets the colors of all vertices to one color.

Parameters
bufferMeshbuffer on which the operation is performed.
colorNew color.

◆ transform() [1/2]

void nirt::scene::IMeshManipulator::transform ( IMesh mesh,
const core::matrix4 m,
u32  normalsUpdate = 0,
bool  normalizeNormals = false 
) const
inline

Applies a transformation to a mesh.

Parameters
meshMesh on which the operation is performed.
mtransformation matrix.
normalsUpdateWhen 0 - don't update normals. When 1 - update normals with inner 3x3 matrix of the inverse transposed of the transformation matrix should be set when the matrix has rotation or non-uniform scaling
normalizeNormalsWhen true it normalizes all normals again. Recommended to set this when normalsUpdate is 1 and there is any scaling

◆ transform() [2/2]

void nirt::scene::IMeshManipulator::transform ( IMeshBuffer buffer,
const core::matrix4 m,
u32  normalsUpdate = 0,
bool  normalizeNormals = false 
) const
inline

Applies a transformation to a meshbuffer.

Parameters
bufferMeshbuffer on which the operation is performed.
mtransformation matrix.
normalsUpdateWhen 0 - don't update normals. When 1 - update normals with inner 3x3 matrix of the inverse transposed of the transformation matrix should be set when the matrix has rotation or non-uniform scaling
normalizeNormalsWhen true it normalizes all normals again. Recommended to set this when normalsUpdate is 1 and there is any scaling

◆ transformMesh()

virtual NIRT_DEPRECATED void nirt::scene::IMeshManipulator::transformMesh ( IMesh mesh,
const core::matrix4 m 
) const
inlinevirtual

Applies a transformation to a mesh.

Deprecated:
Use transform() instead. This method may be removed by Nirtcpp 1.9
Parameters
meshMesh on which the operation is performed.
mtransformation matrix.

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

Nirtcpp    @cppfx.xyz

Utxcpp    utx::print