UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
Sandworm (Experimental)
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin

Unigine::MeshStatic Class

Header: #include <UnigineMeshStatic.h>

This class is used to procedurally create static meshes (i.e. triangles, lines or points) and modify them at run time.

MeshStatic Class

Members


MeshStatic ( ) #

Constructor. Creates an empty static mesh.

int info ( const char * path ) #

Returns an information about the given mesh.

Arguments

  • const char * path - Path to the mesh.

Return value

int load ( const char * path ) #

Loads the mesh using the specified path.

Arguments

  • const char * path - Path to the mesh.

Return value

1 if the mesh is loaded successfully; otherwise, 0.

int save ( const char * path ) const#

Saves the mesh to the specified location.

Arguments

  • const char * path - Path to the mesh.

Return value

1 if the mesh is saved successfully; otherwise, 0.

int setMesh ( const Ptr<Mesh> & mesh ) #

Copies a given source mesh into the current mesh.

Arguments

  • const Ptr<Mesh> & mesh - Source mesh to be copied.

Return value

1 if the mesh is copied successfully; otherwise, 0.

int getMesh ( Ptr<Mesh> & mesh ) const#

Copies the current mesh into the destination mesh.

Arguments

  • Ptr<Mesh> & mesh - Destination mesh.

Return value

true if the mesh is copied successfully; otherwise, false.

void clear ( ) #

Clears the mesh (including its surfaces and bounds).

void destroy ( ) #

Destroys the mesh.

void flush ( ) #

Flushes the mesh geometry into the video memory.

void bind ( ) #

Binds static mesh data (index and vertex buffers) to the input assembler stage.

void unbind ( ) #

Unbinds static mesh data (index and vertex buffers).

int renderSurface ( int mode, int surface, int target = 0 ) #

Renders the surface.

Arguments

  • int mode - Rendering mode. One of the MODE_* variables.
  • int surface
  • int target - Surface target number. The default value is 0.

Return value

Number of primitives rendered. Primitive type is determined by the rendering mode.

int renderInstancedSurface ( int mode, int num, int surface, int target = 0 ) #

Renders the specified number of instances of the surface.

Arguments

  • int mode - Rendering mode. One of the MODE_* variables.
  • int num - Number of instances to be rendered.
  • int surface
  • int target - Surface target number. The default value is 0.

Return value

Number of primitives rendered. Primitive type is determined by the rendering mode.

int render ( int mode, int surface = -1, int target = 0 ) #

Renders the static mesh with the specified settings and mode.

Arguments

  • int mode - Rendering mode. One of the MODE_* variables.
  • int surface - Surface number (use -1 for all surfaces).
  • int target - Surface target number. The default value is 0.

int renderInstanced ( int mode, int num, int surface = -1, int target = 0 ) #

Renders the specified number of instances of the surface.

Arguments

  • int mode - Rendering mode. One of the MODE_* variables.
  • int num - Number of instances to be rendered.
  • int surface - Surface number (use -1 for all surfaces).
  • int target - Surface target number. The default value is 0.

Return value

Number of primitives rendered. Primitive type is determined by the rendering mode.

size_t getSystemMemoryUsage ( ) const#

Returns the current amount of system memory used by the static mesh, in bytes.

Return value

System memory amount used by the static mesh, in bytes.

size_t getVideoMemoryUsage ( ) const#

Returns the current amount of video memory used by the static mesh.

Return value

Video memory amount used by the static mesh, in bytes.

int getNumSurfaces ( ) const#

Returns the total number of mesh surfaces.

Return value

Number of mesh surfaces.

const char * getSurfaceName ( int surface ) const#

Returns the name of the given surface.

Arguments

  • int surface - Mesh surface number.

Return value

Surface name.

void setSurfaceLightmapUVChannel ( int surface, char uv_channel ) #

Sets a new UV channel to be used for lightmaps of the surface with the specified number.

Arguments

  • int surface - Mesh surface number.
  • char uv_channel - UV channel to be used for lightmaps of the surface with the specified number.

char getSurfaceLightmapUVChannel ( int surface ) const#

Returns the current UV channel used for lightmaps of the surface with the specified number.

Arguments

  • int surface - Mesh surface number.

Return value

UV channel currently used for lightmaps of the surface with the specified number.

void setSurfaceLightmapResolution ( int surface, Mesh::LIGHTMAP_RESOLUTION resolution ) #

Sets a new lightmap resolution for the surface with the specified number.

Arguments

  • int surface - Mesh surface number.
  • Mesh::LIGHTMAP_RESOLUTION resolution - Lightmap resolution to be used for the surface with the specified number.

Mesh::LIGHTMAP_RESOLUTION getSurfaceLightmapResolution ( int surface ) const#

Returns the current lightmap resolution for the surface with the specified number.

Arguments

  • int surface - Mesh surface number.

Return value

Current lightmap resolution for the surface with the specified number.

int findSurface ( const char * name ) const#

Searches for the surface number by its name.

Arguments

  • const char * name - Mesh surface name.

Return value

Mesh surface number, if it is found; otherwise, -1.

int getNumSurfaceTargets ( int surface ) const#

Returns the number of surface targets for the given surface.

Arguments

  • int surface - Mesh surface number.

Return value

Number of surface targets.

const char * getSurfaceTargetName ( int surface, int target ) const#

Returns the name of the given surface target.

Arguments

  • int surface - Mesh surface number.
  • int target - Surface target number.

Return value

Surface target name.

int findSurfaceTarget ( const char * name, int surface ) const#

Searches for the target number by the target name.

Arguments

  • const char * name - The name of the target.
  • int surface - Mesh surface number.

Return value

Target number, if exists; otherwise, -1.

void updateSurfaceBounds ( int surface = -1 ) #

Updates mesh bounds. This method is to be called to recalculate bounds after changing a mesh surface (e.g. modifying positions of coordinate vertices).

Arguments

  • int surface - Surface number (use -1 for all surfaces).

void setSurfaceTransform ( const Math::mat4 & transform, int surface, int target = -1 ) #

Sets the transformation matrix for the given surface target.

Arguments

  • const Math::mat4 & transform - Transformation matrix to be set.
  • int surface - Mesh surface number.
  • int target - Surface target number. The default value is -1 (apply to all of the surface targets).

int addMeshSurface ( const char * name, const Ptr<Mesh> & mesh, int surface, int target = -1 ) #

Appends a surface of the source mesh to the current mesh as a new surface.

Arguments

  • const char * name - Name of the new surface added to the current mesh.
  • const Ptr<Mesh> & mesh - Source mesh to copy a surface from.
  • int surface - Number of the source mesh surface to copy.
  • int target - Number of the target of the source mesh surface. The default value is -1 (all of the surface targets).

Return value

Number of the last added surface.

int addMeshSurface ( const char * name, const Ptr<MeshStatic> & mesh, int surface, int target = -1 ) #

Appends a new mesh surface to the current mesh.

Arguments

  • const char * name - Name of the new surface added to the current mesh.
  • const Ptr<MeshStatic> & mesh - Source mesh to copy a surface from.
  • int surface - Number of the source mesh surface to copy.
  • int target - Number of the target of the source mesh surface. The default value is -1 (all of the surface targets).

Return value

Number of the last added surface.

int addMeshSurface ( int dest_surface, const Ptr<MeshStatic> & mesh, int surface, int target = -1 ) #

Appends a new mesh surface to the current mesh.

Arguments

  • int dest_surface - Number of the surface to copy the mesh to.
  • const Ptr<MeshStatic> & mesh - Source mesh to copy a surface from.
  • int surface - Number of the source mesh surface to copy.
  • int target - Number of the target of the source mesh surface. The default value is -1 (all of the surface targets).

Return value

Number of the last added surface.

int getMeshSurface ( Ptr<Mesh> & mesh, int surface, int target = -1 ) const#

Copies the specified mesh surface into the destination mesh.

Arguments

  • Ptr<Mesh> & mesh - Destination mesh pointer to copy a surface into.
  • int surface - Number of the source mesh surface to be copied.
  • int target - Number of the target of the source mesh surface. The default value is -1 (all targets).

Return value

Number of the added mesh surface.

int addEmptySurface ( const char * name, int num_vertex, int num_indices ) #

Appends a new empty surface to the current mesh.
Notice
This function allocates only vertex and index arrays. Texture coordinates, tangent basis, weights and color arrays must be allocated manually.

Arguments

  • const char * name - Surface name.
  • int num_vertex - Number of surface vertices.
  • int num_indices - Number of surface indices.

Return value

Number of the mesh surfaces.

int addSurfaceTarget ( int surface, const char * name ) #

Appends a target with the given name to the given surface.

Arguments

  • int surface - Mesh surface number.
  • const char * name - Name of the surface target.

Return value

Number of surface targets.

int getCollision ( const Math::vec3 & p0, const Math::vec3 & p1, Vector< int > & surfaces ) #

Performs the search for the collision of the given surfaces with the given traced line.
Notice
Mesh local space coordinates are used for this method.

Arguments

  • const Math::vec3 & p0 - Start point coordinates.
  • const Math::vec3 & p1 - End point coordinates.
  • Vector< int > & surfaces - Mesh surfaces.

Return value

1 if the collision is found; otherwise, 0.

int getCollision ( const Math::vec3 & p0, const Math::vec3 & p1, Vector< int > & triangles, int surface ) #

Arguments

  • const Math::vec3 & p0 - Start point coordinates.
  • const Math::vec3 & p1 - End point coordinates.
  • Vector< int > & triangles
  • int surface - Mesh surface number.

Return value

1 if the collision is found; otherwise, 0.

int getCollision ( const BoundBox & bb, Vector< int > & surfaces ) #

Performs the search for the collision of the given surfaces with the given bounding box.

Arguments

  • const BoundBox & bb - Bounding box.
  • Vector< int > & surfaces - Mesh surfaces.

Return value

1 if the collision is found; otherwise, 0.

int getCollision ( const BoundBox & bb, Vector< int > & triangles, int surface ) #

Arguments

  • const BoundBox & bb - Bounding box.
  • Vector< int > & triangles
  • int surface - Mesh surface number.

Return value

1 if the collision is found; otherwise, 0.

int getCollision ( const BoundFrustum & bf, Vector< int > & surfaces ) #

Performs the search for the collision of the given surfaces with the given bounding frustum.

Arguments

Return value

1 if the collision is found; otherwise, 0.

int getCollision ( const BoundFrustum & bf, Vector< int > & triangles, int surface ) #

Arguments

  • const BoundFrustum & bf - Bounding frustum.
  • Vector< int > & triangles
  • int surface - Mesh surface number.

Return value

1 if the collision is found; otherwise, 0.

Vector< char > getEdges ( int surface ) #

Returns the edges that are edges of the mesh geometry, i.e. the neighboring triangles that form these edges are lying in different planes.

Arguments

  • int surface - Mesh surface number.

Return value

Edges that are edges of the mesh geometry.

int getIntersection ( const Math::vec3 & p0, const Math::vec3 & p1, Math::vec3 * ret_point, Math::vec3 * ret_normal, Math::vec4 * ret_texcoord, int * ret_index, int surface, int target = 0 ) #

Performs the search for the intersection of the given surface target with the given traced line.
Notice
Mesh local space coordinates are used for this method.

Arguments

  • const Math::vec3 & p0 - Start point coordinates.
  • const Math::vec3 & p1 - End point coordinates.
  • Math::vec3 * ret_point - Return array to write the intersection point coordinates into.
  • Math::vec3 * ret_normal - Return array to write the intersection point normal into.
  • Math::vec4 * ret_texcoord - Return array to write the texture coordinates into.
  • int * ret_index - Return array to write the intersection point indices into.
  • int surface - Mesh surface number.
  • int target - Surface target number. The default value is 0.

Return value

1 if the intersection is found; otherwise, 0.

int getIntersection ( const Math::dvec3 & p0, const Math::dvec3 & p1, Math::dvec3 * ret_point_, Math::vec3 * ret_normal, Math::vec4 * ret_texcoord, int * ret_index, int surface, int target = 0 ) #

Performs the search for the intersection of the given surface target with the given traced line.
Notice
Mesh local space coordinates are used for this method.

Arguments

  • const Math::dvec3 & p0 - Start point coordinates.
  • const Math::dvec3 & p1 - End point coordinates.
  • Math::dvec3 * ret_point_ - Return array to write the intersection point coordinates into.
  • Math::vec3 * ret_normal - Return array to write the intersection point normal into.
  • Math::vec4 * ret_texcoord - Return array to write the texture coordinates into.
  • int * ret_index - Return array to write the intersection point indices into.
  • int surface - Mesh surface number.
  • int target - Surface target number. The default value is 0.

Return value

1 if the intersection is found; otherwise, 0.

void setBoundBox ( const BoundBox & bb ) #

Sets the bounding box for the mesh.

Arguments

  • const BoundBox & bb - Bounding box to be set.

void setBoundBox ( const BoundBox & bb, int surface ) #

Sets the bounding box for the given mesh surface.

Arguments

  • const BoundBox & bb - Bounding box to be set.
  • int surface - Mesh surface number.

BoundBox getBoundBox ( ) const#

Returns the bounding box of the mesh.

Return value

Bounding box.

BoundBox getBoundBox ( int surface ) const#

Returns the bounding box of the given mesh surface.

Arguments

  • int surface - Mesh surface number.

Return value

Bounding box.

void setBoundSphere ( const BoundSphere & bs ) #

Sets the bounding sphere for the mesh.

Arguments

void setBoundSphere ( const BoundSphere & bs, int surface ) #

Sets the bounding sphere for the given mesh surface.

Arguments

  • const BoundSphere & bs - Bounding sphere to be set.
  • int surface - Mesh surface number.

BoundSphere getBoundSphere ( ) const#

Returns the bounding sphere of the mesh.

Return value

Bounding sphere.

BoundSphere getBoundSphere ( int surface ) const#

Returns the bounding sphere of the given mesh surface.

Arguments

  • int surface - Mesh surface number.

Return value

Bounding sphere.

Vector< Math::vec3 > getVertex ( int surface, int target = 0 ) #

Returns coordinates of the given coordinate vertex of the given surface target.

Arguments

  • int surface - Mesh surface number.
  • int target - Surface target number. The default value is 0.

Return value

Vertex coordinates.

Vector< Math::hvec4 > getTangents ( int surface, int target = 0 ) #

Returns tangents for the given surface target.

Arguments

  • int surface - Mesh surface number.
  • int target - Surface target number. The default value is 0.

Return value

Tangents of the surface target.

Vector< Math::vec2 > getTexCoords0 ( int surface ) #

Returns first UV map texture coordinates of the given surface.

Arguments

  • int surface - Mesh surface number.

Return value

First UV map texture coordinates.

Vector< Math::vec2 > getTexCoords1 ( int surface ) #

Returns second UV map texture coordinates of the given surface.

Arguments

  • int surface - Mesh surface number.

Return value

Second UV map texture coordinates.

Vector< Math::bvec4 > getColors ( int surface ) #

Returns the vertex colors of the given surface.

Arguments

  • int surface - Mesh surface number.

Return value

Vertex colors.

Vector< int > getCIndices ( int surface ) #

Returns the coordinate indices of all vertices of the given surface.

Arguments

  • int surface - Mesh surface number.

Return value

Coordinate indices.

Vector< int > getTIndices ( int surface ) #

Returns the triangle indices of the given surface.

Arguments

  • int surface - Mesh surface number.

Return value

Triangle indices.

void setDebugName ( const char * name ) #

Sets a friendly name for GPU debugging (RenderDoc, NVIDIA Nsight). It can be used to help you determine if the corresponding object interface pointer caused the leak. Memory leaks are reported by the debug software layer by outputting a list of object interface pointers along with their friendly names.

Arguments

  • const char * name - Friendly debug name to be set.

const char * getDebugName ( ) const#

Returns the currently used friendly name for GPU debugging (RenderDoc, NVIDIA Nsight). It can be used to help you determine if the corresponding object interface pointer caused the leak. Memory leaks are reported by the debug software layer by outputting a list of object interface pointers along with their friendly names.

Return value

Friendly debug name.

void updateDebugName ( ) #

Updates the friendly name for GPU debugging (RenderDoc, NVIDIA Nsight).

void createNodes ( ) #

Forced creation of the Mesh Static internal tree for quick calculation of collisions and intersections.
Last update: 2020-11-25