Material Class

A class describing how to draw meshes.

Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

public class Material : ResourceObject

Remarks

A material is a description of how to visualize a triangle mesh. It contains information of how to color, shade and texture map the mesh.

The map describes what the texture looks like, and the map applier describes how to map this map on the surface of the mesh.

Inheritance Hierarchy

System.Object (not available in C#)
  EngineObject
    ResourceObject
      Material

Platforms

Windows, Linux, Android

Material Members

The Material type has the following members.

Constructors

Name	Description
Material	Initializes a new instance of the Material class.

Properties

Name	Description
AlphaThreshold	Gets or sets the alpha threshold value.
AmbientColor	Gets or sets the ambient color of the surface of the mesh.
Color	Gets or sets the diffuse color of the surface of the mesh.
CreaseAngle	Gets or sets a value specifying which edges in the mesh should be seen as sharp edges.
DoubleSided	Gets or sets a value indicating if triangles facing away from the viewer should be rendered.
EmissiveColor	Gets or sets the emissive color of the surface of the mesh.
IsDisposed	Gets a value that tells whether the current Material has been disposed. Inherited from EngineObject
Lighting	Gets or sets a value specifying if the mesh should be shaded by global illumination.
Map	Gets or sets the texture map that should be applied on the surface of the mesh.
MapApplier	Gets or sets an object specifying how the Map should be mapped onto the surface of the mesh.
Name	Gets or sets the name of the Material. Inherited from ResourceObject
NativeHandle	Gets the native Carmenta Engine kernel object the current Material represents. Inherited from EngineObject
Shininess	Gets or sets a value indicating how shiny the mesh surface is.
SpecularColor	Gets or sets the specular color of the mesh.
IUserProperties.UserProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties
Wireframe	Gets or sets a flag indicating if the mesh should be drawn normally, or as a wire frame.

Methods

Name	Description
Clone	Creates a copy of an object. Inherited from EngineObject
Dispose	Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject
Equals	Determines whether this instance is equal to another. Inherited from EngineObject

Material Class

A class describing how to draw meshes.

Namespace: Carmenta::Engine
Include: <Carmenta/Engine/Core.hpp>
Dynamic link library: CECore.Cpp64.dll
Library: CECore.Cpp64.lib

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

C++

class Material : public ResourceObject

C++ Smart Pointer Declaration

typedef Ptr<Material> MaterialPtr;

Remarks

A material is a description of how to visualize a triangle mesh. It contains information of how to color, shade and texture map the mesh.

The map describes what the texture looks like, and the map applier describes how to map this map on the surface of the mesh.

Inheritance Hierarchy

EngineObject
ResourceObject
Material

Platforms

Windows, Linux, Android

Material Members

The Material type has the following members.

Constructors

Name	Description
Material	Initializes a new instance of the Material class.

Properties

Name	Description
alphaThreshold	Gets or sets the alpha threshold value.
ambientColor	Gets or sets the ambient color of the surface of the mesh.
color	Gets or sets the diffuse color of the surface of the mesh.
creaseAngle	Gets or sets a value specifying which edges in the mesh should be seen as sharp edges.
doubleSided	Gets or sets a value indicating if triangles facing away from the viewer should be rendered.
emissiveColor	Gets or sets the emissive color of the surface of the mesh.
lighting	Gets or sets a value specifying if the mesh should be shaded by global illumination.
map	Gets or sets the texture map that should be applied on the surface of the mesh.
mapApplier	Gets or sets an object specifying how the map should be mapped onto the surface of the mesh.
name	Gets or sets the name of the Material. Inherited from ResourceObject
shininess	Gets or sets a value indicating how shiny the mesh surface is.
specularColor	Gets or sets the specular color of the mesh.
IUserProperties::userProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties
wireframe	Gets or sets a flag indicating if the mesh should be drawn normally, or as a wire frame.

Methods

Name	Description
clone	Creates a copy of an object. Inherited from EngineObject
equals	Determines whether this instance is equal to another. Inherited from EngineObject

Material Class

A class describing how to draw meshes.

Package: com.carmenta.engine.core
JAR file: CECore.Java.jar

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

Java

public class Material extends ResourceObject

Remarks

A material is a description of how to visualize a triangle mesh. It contains information of how to color, shade and texture map the mesh.

The map describes what the texture looks like, and the map applier describes how to map this map on the surface of the mesh.

Inheritance Hierarchy

System::Object (not available in Java)
  EngineObject
    ResourceObject
      Material

Platforms

Windows, Linux, Android

Material Members

The Material type has the following members.

Constructors

Name	Description
Material	Initializes a new instance of the Material class.

Properties

Name	Description
alphaThreshold	Gets or sets the alpha threshold value.
ambientColor	Gets or sets the ambient color of the surface of the mesh.
color	Gets or sets the diffuse color of the surface of the mesh.
creaseAngle	Gets or sets a value specifying which edges in the mesh should be seen as sharp edges.
doubleSided	Gets or sets a value indicating if triangles facing away from the viewer should be rendered.
emissiveColor	Gets or sets the emissive color of the surface of the mesh.
isDisposed	Gets a value that tells whether the current Material has been disposed. Inherited from EngineObject
lighting	Gets or sets a value specifying if the mesh should be shaded by global illumination.
map	Gets or sets the texture map that should be applied on the surface of the mesh.
mapApplier	Gets or sets an object specifying how the map should be mapped onto the surface of the mesh.
name	Gets or sets the name of the Material. Inherited from ResourceObject
shininess	Gets or sets a value indicating how shiny the mesh surface is.
specularColor	Gets or sets the specular color of the mesh.
IUserProperties.userProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties
wireframe	Gets or sets a flag indicating if the mesh should be drawn normally, or as a wire frame.

Methods

Name	Description
clone	Creates a copy of an object. Inherited from EngineObject
dispose	Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject
equals	Determines whether this instance is equal to another. Inherited from EngineObject

Material Class

A class describing how to draw meshes.

Module: Carmenta.Engine.Core (in Core.pyd)

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

Python

class Material ( ResourceObject )

Remarks

A material is a description of how to visualize a triangle mesh. It contains information of how to color, shade and texture map the mesh.

The map describes what the texture looks like, and the map applier describes how to map this map on the surface of the mesh.

Inheritance Hierarchy

EngineObject
ResourceObject
Material

Platforms

Windows, Linux, Android

Material Members

The Material type has the following members.

Constructors

Name	Description
Material	Initializes a new instance of the Material class.

Properties

Name	Description
alphaThreshold	Gets or sets the alpha threshold value.
ambientColor	Gets or sets the ambient color of the surface of the mesh.
color	Gets or sets the diffuse color of the surface of the mesh.
creaseAngle	Gets or sets a value specifying which edges in the mesh should be seen as sharp edges.
doubleSided	Gets or sets a value indicating if triangles facing away from the viewer should be rendered.
emissiveColor	Gets or sets the emissive color of the surface of the mesh.
lighting	Gets or sets a value specifying if the mesh should be shaded by global illumination.
map	Gets or sets the texture map that should be applied on the surface of the mesh.
mapApplier	Gets or sets an object specifying how the map should be mapped onto the surface of the mesh.
name	Gets or sets the name of the Material. Inherited from ResourceObject
shininess	Gets or sets a value indicating how shiny the mesh surface is.
specularColor	Gets or sets the specular color of the mesh.
IUserProperties.userProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties
wireframe	Gets or sets a flag indicating if the mesh should be drawn normally, or as a wire frame.

Methods

Name	Description
clone	Creates a copy of an object. Inherited from EngineObject
equals	Determines whether this instance is equal to another. Inherited from EngineObject

Material Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

Material Members

Material Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

Material Members

Material Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

Material Members

Material Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

Material Members