ImportMesh Class

WarningThe scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.

Warning

The functionality described in this article is not available in the Community SDK edition.
You should upgrade to Engineering / Sim SDK edition to use it.

Methods:

Name	Description View: Sort by:
ImportMesh	Constructor.
setData	Setter and Getter for metadata of the imported mesh.
getData	Setter and Getter for metadata of the imported mesh.
setName	Setter and Getter for name of the mesh.
getName	Setter and Getter for name of the mesh.
setFilepath	Setter and Getter for path to the output mesh file.
getFilepath	Setter and Getter for path to the output mesh file.
setHasAnimations	Setter and Getter for value indicating if the mesh has animations.
getHasAnimations
setAnimationFilepath	Setter and Getter for path to the output animation file.
getAnimationFilepath	Setter and Getter for path to the output animation file.
getNumNodes	Returns the number of import nodes to which the mesh is attached as an attribute.
addNode	Adds a new node to the list of import nodes to which the mesh is attached as an attribute.
removeNode	Removes the specified import node from the list of import nodes to which the mesh is attached as an attribute.
getNode	Returns an import node with the specified index from the list of import nodes to which the mesh is attached as an attribute.
getNumGeometries	Returns the number of elements in the mesh geometry list (a set of ImportGeometry elements making up the geometry of the mesh).
addGeometry	Adds a new element to the mesh geometry list and returns the corresponding ImportGeometry instance.
copyGeometriesFrom	Copies all geometry elements from the specified source mesh and adds them to the mesh geometry list (a set of ImportGeometry elements making up the geometry of the mesh).
moveGeometriesFrom	Moves all geometry elements from the specified source mesh and adds them to the mesh geometry list (a set of ImportGeometry elements making up the geometry of the mesh).
getGeometry	Returns an element of mesh geometry by its index.
clearGeometries	Clears the geometry list of the mesh (a set of ImportGeometry elements making up the geometry of the mesh).

ImportMesh Class

Members

void setData ( vptr data ) #

Sets a new metadata of the imported mesh.

Arguments

vptr data - The mesh metadata.

vptr getData() const#

Returns the current metadata of the imported mesh.

Return value

Current mesh metadata.

void setName ( string name ) #

Sets a new name of the mesh.

Arguments

string name - The mesh name.

string getName() const#

Returns the current name of the mesh.

Return value

Current mesh name.

void setFilepath ( string filepath ) #

Sets a new path to the output mesh file.

Arguments

string filepath - The output mesh file path.

string getFilepath() const#

Returns the current path to the output mesh file.

Return value

Current output mesh file path.

void setHasAnimations ( int animations ) #

Sets a new value indicating if the mesh has animations.

Arguments

int animations - The the mesh has animations

int isHasAnimations() const#

Returns the current value indicating if the mesh has animations.

Return value

Current the mesh has animations

void setAnimationFilepath ( string filepath ) #

Sets a new path to the output animation file.

Arguments

string filepath - The output animation file path.

string getAnimationFilepath() const#

Returns the current path to the output animation file.

Return value

Current output animation file path.

ImportMesh ( ) #

Constructor. Creates an empty ImportMesh instance.

int getNumNodes ( ) #

Returns the number of import nodes to which the mesh is attached as an attribute.

Return value

Number of nodes to which the mesh is attached as an attribute.

void addNode ( ImportNode node ) #

Adds a new node to the list of import nodes to which the mesh is attached as an attribute.

Arguments

ImportNode node - New import node to be added.

bool removeNode ( ImportNode node ) #

Removes the specified import node from the list of import nodes to which the mesh is attached as an attribute.

Arguments

ImportNode node - Node to be removed.

Return value

true if the specified import node was successfully removed from the list; otherwise false.

ImportNode getNode ( int index ) #

Returns an import node with the specified index from the list of import nodes to which the mesh is attached as an attribute.

Arguments

int index - Index of node in the list.

Return value

Import node with the specified index (if it exists).

int getNumGeometries ( ) #

Returns the number of elements in the mesh geometry list (a set of ImportGeometry elements making up the geometry of the mesh).

Return value

Number of elements in the mesh geometry list.

ImportGeometry addGeometry ( ) #

Adds a new element to the mesh geometry list and returns the corresponding ImportGeometry instance.

Return value

New added geometry element.

void copyGeometriesFrom ( ImportMesh other ) #

Copies all geometry elements from the specified source mesh and adds them to the mesh geometry list (a set of ImportGeometry elements making up the geometry of the mesh).

Arguments

ImportMesh other - Source mesh.

void moveGeometriesFrom ( ImportMesh other ) #

Moves all geometry elements from the specified source mesh and adds them to the mesh geometry list (a set of ImportGeometry elements making up the geometry of the mesh).

Arguments

ImportMesh other - Source mesh.

ImportGeometry getGeometry ( int index ) #

Returns an element of mesh geometry by its index. Geometry of the mesh can consist of multiple ImportGeometry elements.

Arguments

int index - Index of geometry element.

Return value

Geometry element with the specified index.

void clearGeometries ( ) #

Clears the geometry list of the mesh (a set of ImportGeometry elements making up the geometry of the mesh).

Last update: 2022-12-14

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)

ImportMesh Class

In This Article:

Methods:

ImportMesh Class

Members

void setData ( vptr data ) #

Arguments

vptr getData() const#

Return value

void setName ( string name ) #

Arguments

string getName() const#

Return value

void setFilepath ( string filepath ) #

Arguments

string getFilepath() const#

Return value

void setHasAnimations ( int animations ) #

Arguments

int isHasAnimations() const#

Return value

void setAnimationFilepath ( string filepath ) #

Arguments

string getAnimationFilepath() const#

Return value

ImportMesh ( ) #

int getNumNodes ( ) #

Return value

void addNode ( ImportNode node ) #

Arguments

bool removeNode ( ImportNode node ) #

Arguments

Return value

ImportNode getNode ( int index ) #

Arguments

Return value

int getNumGeometries ( ) #

Return value

ImportGeometry addGeometry ( ) #

Return value

void copyGeometriesFrom ( ImportMesh other ) #

Arguments

void moveGeometriesFrom ( ImportMesh other ) #

Arguments

ImportGeometry getGeometry ( int index ) #

Arguments

Return value

void clearGeometries ( ) #