class sap.ui.vk.Material

Control sample: sap.ui.vk.Material
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/vk/Material
Application Component: CA-UI5-VTK

Provides the interface for the material.

The objects of this class should not be created directly.


Constructor

Constructor for a new Material.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.

new sap.ui.vk.Material()

Properties

Name Type Default Value Description
ambientColour sap.ui.core.CSSColor rgba(0, 0, 0, 1)

Ambient colour (optional) - red, green, blue, and alpha

Visibility: public
diffuseColour sap.ui.core.CSSColor rgba(0, 0, 0, 1)

Diffuse colour (optional) - red, green, blue, and alpha

Visibility: public
emissiveColour sap.ui.core.CSSColor rgba(0, 0, 0, 1)

Emissive colour (optional) - red, green, blue, and alpha

Visibility: public
glossiness float 0

Glossiness (optional)

Visibility: public
id string

Material id

Visibility: public
lineColour sap.ui.core.CSSColor rgba(0, 0, 0, 1)

Line colour (optional) - red, green, blue, and alpha

Visibility: public
lineWidth float 0

Line width (optional)

Visibility: public
name string

Material name

Visibility: public
opacity float 1

Opacity (optional)

Visibility: public
specularColour sap.ui.core.CSSColor rgba(0, 0, 0, 1)

Specular colour (optional) - red, green, blue, and alpha

Visibility: public
textureAmbientOcclusion sap.ui.vk.Texture

Ambient occlusion texture (optional)

Visibility: public
textureBump sap.ui.vk.Texture

Bump texture (optional)

Visibility: public
textureDiffuse sap.ui.vk.Texture

Diffuse texture (optional)

Visibility: public
textureEmissive sap.ui.vk.Texture

Emissive texture (optional)

Visibility: public
textureOpacity sap.ui.vk.Texture

Opacity texture (optional)

Visibility: public
textureReflection sap.ui.vk.Texture

Reflection texture (optional)

Visibility: public

Methods Overview

Method Description
sap.ui.vk.Material.extend

Creates a new subclass of class sap.ui.vk.Material with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.base.ManagedObject.extend.

getAmbientColour

Gets current value of property ambientColour.

Ambient colour (optional) - red, green, blue, and alpha

Default value is "rgba(0, 0, 0, 1)".

getDiffuseColour

Gets current value of property diffuseColour.

Diffuse colour (optional) - red, green, blue, and alpha

Default value is "rgba(0, 0, 0, 1)".

getEmissiveColour

Gets current value of property emissiveColour.

Emissive colour (optional) - red, green, blue, and alpha

Default value is "rgba(0, 0, 0, 1)".

getGlossiness

Gets current value of property glossiness.

Glossiness (optional)

Default value is 0.0.

getId

Gets current value of property id.

Material id

getLineColour

Gets current value of property lineColour.

Line colour (optional) - red, green, blue, and alpha

Default value is "rgba(0, 0, 0, 1)".

getLineWidth

Gets current value of property lineWidth.

Line width (optional)

Default value is 0.0.

getMaterialRef
sap.ui.vk.Material.getMetadata

Returns a metadata object for class sap.ui.vk.Material.

getName

Gets current value of property name.

Material name

getOpacity

Gets current value of property opacity.

Opacity (optional)

Default value is 1.0.

getSpecularColour

Gets current value of property specularColour.

Specular colour (optional) - red, green, blue, and alpha

Default value is "rgba(0, 0, 0, 1)".

getTextureAmbientOcclusion

Gets current value of property textureAmbientOcclusion.

Ambient occlusion texture (optional)

getTextureBump

Gets current value of property textureBump.

Bump texture (optional)

getTextureDiffuse

Gets current value of property textureDiffuse.

Diffuse texture (optional)

getTextureEmissive

Gets current value of property textureEmissive.

Emissive texture (optional)

getTextureOpacity

Gets current value of property textureOpacity.

Opacity texture (optional)

getTextureReflection

Gets current value of property textureReflection.

Reflection texture (optional)

setAmbientColour

Sets a new value for property ambientColour.

Ambient colour (optional) - red, green, blue, and alpha

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "rgba(0, 0, 0, 1)".

setDiffuseColour

Sets a new value for property diffuseColour.

Diffuse colour (optional) - red, green, blue, and alpha

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "rgba(0, 0, 0, 1)".

setEmissiveColour

Sets a new value for property emissiveColour.

Emissive colour (optional) - red, green, blue, and alpha

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "rgba(0, 0, 0, 1)".

setGlossiness

Sets a new value for property glossiness.

Glossiness (optional)

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 0.0.

setId

Sets a new value for property id.

Material id

When called with a value of null or undefined, the default value of the property will be restored.

setLineColour

Sets a new value for property lineColour.

Line colour (optional) - red, green, blue, and alpha

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "rgba(0, 0, 0, 1)".

setLineWidth

Sets a new value for property lineWidth.

Line width (optional)

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 0.0.

setName

Sets a new value for property name.

Material name

When called with a value of null or undefined, the default value of the property will be restored.

setOpacity

Sets a new value for property opacity.

Opacity (optional)

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 1.0.

setSpecularColour

Sets a new value for property specularColour.

Specular colour (optional) - red, green, blue, and alpha

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "rgba(0, 0, 0, 1)".

setTextureAmbientOcclusion

Sets a new value for property textureAmbientOcclusion.

Ambient occlusion texture (optional)

When called with a value of null or undefined, the default value of the property will be restored.

setTextureBump

Sets a new value for property textureBump.

Bump texture (optional)

When called with a value of null or undefined, the default value of the property will be restored.

setTextureDiffuse

Sets a new value for property textureDiffuse.

Diffuse texture (optional)

When called with a value of null or undefined, the default value of the property will be restored.

setTextureEmissive

Sets a new value for property textureEmissive.

Emissive texture (optional)

When called with a value of null or undefined, the default value of the property will be restored.

setTextureOpacity

Sets a new value for property textureOpacity.

Opacity texture (optional)

When called with a value of null or undefined, the default value of the property will be restored.

setTextureReflection

Sets a new value for property textureReflection.

Reflection texture (optional)

When called with a value of null or undefined, the default value of the property will be restored.

sap.ui.vk.Material.extend

Creates a new subclass of class sap.ui.vk.Material with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.base.ManagedObject.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

getAmbientColour

Gets current value of property ambientColour.

Ambient colour (optional) - red, green, blue, and alpha

Default value is "rgba(0, 0, 0, 1)".

getDiffuseColour

Gets current value of property diffuseColour.

Diffuse colour (optional) - red, green, blue, and alpha

Default value is "rgba(0, 0, 0, 1)".

getEmissiveColour

Gets current value of property emissiveColour.

Emissive colour (optional) - red, green, blue, and alpha

Default value is "rgba(0, 0, 0, 1)".

getGlossiness

Gets current value of property glossiness.

Glossiness (optional)

Default value is 0.0.

getId

Gets current value of property id.

Material id

getLineColour

Gets current value of property lineColour.

Line colour (optional) - red, green, blue, and alpha

Default value is "rgba(0, 0, 0, 1)".

getLineWidth

Gets current value of property lineWidth.

Line width (optional)

Default value is 0.0.

getMaterialRef

sap.ui.vk.Material.getMetadata

Returns a metadata object for class sap.ui.vk.Material.

getName

Gets current value of property name.

Material name

getOpacity

Gets current value of property opacity.

Opacity (optional)

Default value is 1.0.

getSpecularColour

Gets current value of property specularColour.

Specular colour (optional) - red, green, blue, and alpha

Default value is "rgba(0, 0, 0, 1)".

getTextureAmbientOcclusion

Gets current value of property textureAmbientOcclusion.

Ambient occlusion texture (optional)

getTextureBump

Gets current value of property textureBump.

Bump texture (optional)

getTextureDiffuse

Gets current value of property textureDiffuse.

Diffuse texture (optional)

getTextureEmissive

Gets current value of property textureEmissive.

Emissive texture (optional)

getTextureOpacity

Gets current value of property textureOpacity.

Opacity texture (optional)

getTextureReflection

Gets current value of property textureReflection.

Reflection texture (optional)

setAmbientColour

Sets a new value for property ambientColour.

Ambient colour (optional) - red, green, blue, and alpha

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "rgba(0, 0, 0, 1)".

Param Type DefaultValue Description
sAmbientColour sap.ui.core.CSSColor "rgba(0, 0, 0, 1)"

New value for property ambientColour

setDiffuseColour

Sets a new value for property diffuseColour.

Diffuse colour (optional) - red, green, blue, and alpha

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "rgba(0, 0, 0, 1)".

Param Type DefaultValue Description
sDiffuseColour sap.ui.core.CSSColor "rgba(0, 0, 0, 1)"

New value for property diffuseColour

setEmissiveColour

Sets a new value for property emissiveColour.

Emissive colour (optional) - red, green, blue, and alpha

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "rgba(0, 0, 0, 1)".

Param Type DefaultValue Description
sEmissiveColour sap.ui.core.CSSColor "rgba(0, 0, 0, 1)"

New value for property emissiveColour

setGlossiness

Sets a new value for property glossiness.

Glossiness (optional)

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 0.0.

Param Type DefaultValue Description
fGlossiness float 0.0

New value for property glossiness

setId

Sets a new value for property id.

Material id

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sId string

New value for property id

setLineColour

Sets a new value for property lineColour.

Line colour (optional) - red, green, blue, and alpha

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "rgba(0, 0, 0, 1)".

Param Type DefaultValue Description
sLineColour sap.ui.core.CSSColor "rgba(0, 0, 0, 1)"

New value for property lineColour

setLineWidth

Sets a new value for property lineWidth.

Line width (optional)

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 0.0.

Param Type DefaultValue Description
fLineWidth float 0.0

New value for property lineWidth

setName

Sets a new value for property name.

Material name

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sName string

New value for property name

setOpacity

Sets a new value for property opacity.

Opacity (optional)

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 1.0.

Param Type DefaultValue Description
fOpacity float 1.0

New value for property opacity

setSpecularColour

Sets a new value for property specularColour.

Specular colour (optional) - red, green, blue, and alpha

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "rgba(0, 0, 0, 1)".

Param Type DefaultValue Description
sSpecularColour sap.ui.core.CSSColor "rgba(0, 0, 0, 1)"

New value for property specularColour

setTextureAmbientOcclusion

Sets a new value for property textureAmbientOcclusion.

Ambient occlusion texture (optional)

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sTextureAmbientOcclusion sap.ui.vk.Texture

New value for property textureAmbientOcclusion

setTextureBump

Sets a new value for property textureBump.

Bump texture (optional)

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sTextureBump sap.ui.vk.Texture

New value for property textureBump

setTextureDiffuse

Sets a new value for property textureDiffuse.

Diffuse texture (optional)

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sTextureDiffuse sap.ui.vk.Texture

New value for property textureDiffuse

setTextureEmissive

Sets a new value for property textureEmissive.

Emissive texture (optional)

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sTextureEmissive sap.ui.vk.Texture

New value for property textureEmissive

setTextureOpacity

Sets a new value for property textureOpacity.

Opacity texture (optional)

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sTextureOpacity sap.ui.vk.Texture

New value for property textureOpacity

setTextureReflection

Sets a new value for property textureReflection.

Reflection texture (optional)

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sTextureReflection sap.ui.vk.Texture

New value for property textureReflection