Mobilizing.js

API Documentation

for 0.0.1
Show:

Material Class

Defined in: src/js/Mobilizing/scene/Material.js:7

A material will give color and some effect to the surface of the 3D object. Mobilizing.js is heavily based on the one of Three.js http://threejs.org/docs/#Reference/Materials/Material and its variations

Constructor

Material

(
  • params
)

Defined in src/js/Mobilizing/scene/Material.js:7

Parameters:

  • params Object

    an object containing all the possible parameters for this class. Use it like in the following example. Possible parameters are lisited below.

    • [type="basic"] String optional

      the type of the matrial, one of "basic", "projectionmapping", "phong", "line", "sprite"

Example:

//this is how to use a parameters object in order to instanciate a Mobilizing.js object
var mobilizingObject = new Mobilizing.Class({paramName1: value, paramName2: value});

Methods

getAlphaTest

() Number

Defined in src/js/Mobilizing/scene/Material.js:258

Returns:

Number:

getColor

() Color

Defined in src/js/Mobilizing/scene/Material.js:186

Returns:

Color:

getDoubleSided

() Boolean

Defined in src/js/Mobilizing/scene/Material.js:240

Returns:

Boolean:

getEmissiveColor

() Color

Defined in src/js/Mobilizing/scene/Material.js:362

Returns:

Color:

getLineWidth

() Number

Defined in src/js/Mobilizing/scene/Material.js:300

Returns:

Number:

getOpacity

() Float

Defined in src/js/Mobilizing/scene/Material.js:222

Returns:

Float:

getPointSize

() Number

Defined in src/js/Mobilizing/scene/Material.js:320

Returns:

Number:

getShininess

() Number

Defined in src/js/Mobilizing/scene/Material.js:343

Returns:

Number:

getSpecularColor

() Color

Defined in src/js/Mobilizing/scene/Material.js:390

Returns:

Color:

getTexture

() Texture

Defined in src/js/Mobilizing/scene/Material.js:137

Gets the current texture

Returns:

Texture:

getTransparent

() Boolean

Defined in src/js/Mobilizing/scene/Material.js:167

Returns:

Boolean:

getWireframe

() Boolean

Defined in src/js/Mobilizing/scene/Material.js:204

Returns:

Boolean:

setAlphaTest

(
  • val
)

Defined in src/js/Mobilizing/scene/Material.js:249

Parameters:

  • val Number

    between 0 and 1

setBlending

(
  • name
)

Defined in src/js/Mobilizing/scene/Material.js:422

Parameters:

  • name String

setColor

(
  • color
)

Defined in src/js/Mobilizing/scene/Material.js:176

Parameters:

setDepthTest Sets the depth test.

(
  • bool
)

Defined in src/js/Mobilizing/scene/Material.js:279

Parameters:

  • bool Boolean
    • The depthTest value

setDepthWrite Sets the depth write.

(
  • bool
)

Defined in src/js/Mobilizing/scene/Material.js:267

Parameters:

  • bool Boolean
    • The depthWrite value

setDoubleSided

(
  • sided
)

Defined in src/js/Mobilizing/scene/Material.js:231

Parameters:

  • sided Boolean

setEmissiveColor

(
  • color
)

Defined in src/js/Mobilizing/scene/Material.js:352

Parameters:

setLineWidth

(
  • val
)

Defined in src/js/Mobilizing/scene/Material.js:291

Parameters:

  • val Number

setOpacity

(
  • op
)

Defined in src/js/Mobilizing/scene/Material.js:213

Parameters:

  • op Float

    between 0 and 1

setPointSize

(
  • val
)

Defined in src/js/Mobilizing/scene/Material.js:309

Parameters:

  • val Number

setProperty

(
  • name
)
Object

Defined in src/js/Mobilizing/scene/Material.js:412

Parameters:

  • name String

Returns:

Object:

value (depending on the property)

setProperty

(
  • name
  • value
)

Defined in src/js/Mobilizing/scene/Material.js:402

Parameters:

  • name String
  • value Object

    (depending on the property)

setShading

(
  • shading
)

Defined in src/js/Mobilizing/scene/Material.js:371

Parameters:

  • shading String

    one of "smooth", "flat"

setShininess

(
  • color
)

Defined in src/js/Mobilizing/scene/Material.js:333

Parameters:

  • color Number

setSpecularColor

(
  • color
)

Defined in src/js/Mobilizing/scene/Material.js:381

Parameters:

setTexture

(
  • texture
)

Defined in src/js/Mobilizing/scene/Material.js:108

set the texture

Parameters:

setTransparent

(
  • trans
)

Defined in src/js/Mobilizing/scene/Material.js:158

Parameters:

  • trans Boolean

setUniform

(
  • name
  • value
)

Defined in src/js/Mobilizing/scene/Material.js:148

Parameters:

  • name String

    the name of the uniform to set

  • value Object

    the value of the uniform to set

setWireframe

(
  • wireframe
)

Defined in src/js/Mobilizing/scene/Material.js:195

Parameters:

  • wireframe Boolean