This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
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
Rendering-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Unigine::ImportMaterial Class

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.
Header: #include <UnigineImport.h>

This class represents a container of metadata for an imported material.

ImportMaterial Class

Members

void setData ( void * data ) #

Sets a new metadata of the imported material.

Arguments

  • void * data - The material metadata.

void * getData() const#

Returns the current metadata of the imported material.

Return value

Current material metadata.

void setName ( const char * name ) #

Sets a new name of the imported material.

Arguments

  • const char * name - The material name.

const char * getName() const#

Returns the current name of the imported material.

Return value

Current material name.

void setFilepath ( const char * filepath ) #

Sets a new path to the material's *.mat output file.

Arguments

  • const char * filepath - The output material file path.

const char * getFilepath() const#

Returns the current path to the material's *.mat output file.

Return value

Current output material file path.

ImportMaterial ( ) #

Constructor. Creates an empty ImportMaterial instance.

int getNumParameters ( ) const#

Returns the number of parameters of the imported material.

Return value

Number of material parameters.

Math::vec4 getParameter ( int index ) const#

Returns the value of the material parameter by its index in the list.

Arguments

Return value

Value of the material parameter with the specified index.

const char * getParameterName ( int index ) const#

Returns the name of the material parameter by its index in the list.

Arguments

Return value

Name of the material parameter with the specified index (if it exists).

void setParameter ( const char * name, const Math::vec4 & value ) #

Sets a new value for the material parameter with the specified name.

Arguments

  • const char * name - Name of the material parameter.
  • const Math::vec4 & value - New parameter value to be set.

bool hasParameter ( const char * name ) const#

Returns a value indicating if the material has a parameter with the specified name.

Arguments

  • const char * name - Name of the material parameter to be checked.

Return value

true if the material has a parameter with the specified name; otherwise false.

void removeParameter ( const char * name ) #

Removes a parameter of the imported material by its name.

Arguments

  • const char * name - Name of the material parameter to be removed.

Math::vec4 getParameter ( const char * name ) const#

Returns the value of the material parameter with the specified name.

Arguments

  • const char * name - Material parameter name.

Return value

Material parameter value as a four-component vector.

int getNumTextures ( ) const#

Returns the number of textures used in the imported material.

Return value

Number of textures used in the imported material.

Ptr<ImportTexture> getTexture ( int index ) const#

Returns a texture used in the material by its index.

Arguments

Return value

Material texture with the specified index.

const char * getTextureName ( int index ) const#

Returns the name of the texture with the specified index.

Arguments

Return value

Name of the material texture with the specified index.

void setTexture ( const char * name, const Ptr<ImportTexture> & value ) #

Sets a new imported texture to be used for the material texture with the specified name.

Arguments

  • const char * name - Material texture name.
  • const Ptr<ImportTexture> & value - New texture to be set.

Ptr<ImportTexture> getTexture ( const char * name ) const#

Returns a texture used in the material by its name.

Arguments

  • const char * name - Material texture name.

Return value

Imported texture currently set as the specified material texture.

bool hasTexture ( const char * name ) const#

Returns a value indicating if the material has a texture with the specified name.

Arguments

  • const char * name - Texture name to be checked.

Return value

true if the material has a texture with the specified name; otherwise false.

void removeTexture ( const char * name ) #

Removes a texture of the imported material by its name.

Arguments

  • const char * name - Name of the material texture to be removed.
Last update: 2023-06-23
Build: ()