ImportSurface Class
Warning
The 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.
You should upgrade to
ImportSurface Class
Members
void setBoundBox ( WorldBoundBox box ) #
Sets a new bounding box of the geometry element.
Arguments
- WorldBoundBox box - The geometry element bounding box.
WorldBoundBox getBoundBox() const#
Returns the current bounding box of the geometry element.
Return value
Current geometry element bounding box.void setData ( vptr data ) #
Sets a new metadata of the imported surface.
Arguments
- vptr data - The surface metadata.
vptr getData() const#
Returns the current metadata of the imported surface.
Return value
Current surface metadata.void setName ( string name ) #
Sets a new name of the imported surface.
Arguments
- string name - The surface name.
string getName() const#
Returns the current name of the imported surface.
Return value
Current surface name.void setMaterial ( ImportMaterial material ) #
Sets a new material assigned to the imported surface.
Arguments
- ImportMaterial material - The surface material: ImportMaterial class instance if a material is assigned to the imported surface; otherwise, nullptr
ImportMaterial getMaterial() const#
Returns the current material assigned to the imported surface.
Return value
Current surface material: ImportMaterial class instance if a material is assigned to the imported surface; otherwise, nullptrvoid setMaxFadeDistance ( float distance ) #
Sets a new Maximum Fade Distance for the imported surface.
Arguments
- float distance - The maximum fade distance, in units.
float getMaxFadeDistance() const#
Returns the current Maximum Fade Distance for the imported surface.
Return value
Current maximum fade distance, in units.void setMinFadeDistance ( float distance ) #
Sets a new Minimum Fade Distance for the imported surface.
Arguments
- float distance - The minimum fade distance, in units.
float getMinFadeDistance() const#
Returns the current Minimum Fade Distance for the imported surface.
Return value
Current minimum fade distance, in units.void setMaxVisibleDistance ( float distance ) #
Sets a new Maximum Visibility Distance for the imported surface.
Arguments
- float distance - The maximum visibility distance, in units.
float getMaxVisibleDistance() const#
Returns the current Maximum Visibility Distance for the imported surface.
Return value
Current maximum visibility distance, in units.void setMinVisibleDistance ( float distance ) #
Sets a new Minimum Visibility Distance for the imported surface.
Arguments
- float distance - The minimum visibility distance, in units.
float getMinVisibleDistance() const#
Returns the current Minimum Visibility Distance for the imported surface.
Return value
Current minimum visibility distance, in units.void setSourceIndex ( int index ) #
Sets a new index of the surface in the source file (FBX, glTF).
Arguments
- int index - The sufrace index in the source file (FBX, glTF).
int getSourceIndex() const#
Returns the current index of the surface in the source file (FBX, glTF).
Return value
Current sufrace index in the source file (FBX, glTF).void setTargetSurface ( int surface ) #
Sets a new number of the morph target surface for the imported surface.
Arguments
- int surface - The morph target surface number if any; otherwise, -1.
int getTargetSurface() const#
Returns the current number of the morph target surface for the imported surface.
Return value
Current morph target surface number if any; otherwise, -1.void copyFrom ( ImportSurface o ) #
Copies the data from the specified source surface.Arguments
- ImportSurface o - Source surface.
Last update:
2024-03-27
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)