API Docs for:

Texture

A Texture specifies a texture map.

Overview

  • Textures are grouped within Materials, which are attached to Meshes.
  • To create a Texture from an image file, set the Texture's src property to the image file path.
  • To create a Texture from an HTMLImageElement, set the Texture's image property to the HTMLImageElement.

Examples

Usage

In this example we have a Mesh with

Note that xeogl will ignore the PhongMaterial's diffuse and specular properties, since we assigned Textures to the PhongMaterial's diffuseMap and specularMap properties. The Textures' pixel colors directly provide the diffuse and specular components for each fragment across the Geometry surface.

var mesh = new xeogl.Mesh({

   material: new xeogl.PhongMaterial({
       ambient: [0.3, 0.3, 0.3],
       diffuse: [0.5, 0.5, 0.0],   // Ignored, since we have assigned a Texture to diffuseMap, below
       specular: [1.0, 1.0, 1.0],   // Ignored, since we have assigned a Texture to specularMap, below
       diffuseMap: new xeogl.Texture({
           src: "diffuseMap.jpg"
       }),
       specularMap: new xeogl.Fresnel({
           src: "diffuseMap.jpg"
       }),
       shininess: 80, // Default
       alpha: 1.0 // Default
   }),

   geometry: new xeogl.TorusGeometry()
});

Constructor

Texture

(
  • [owner]
  • [cfg]
)

Parameters:

  • [owner] Component optional

    Owner component. When destroyed, the owner will destroy this component as well. Creates this component within the default Scene when omitted.

  • [cfg] optional

    Configs

    • [id] String optional

      Optional ID for this Texture, unique among all components in the parent scene, generated automatically when omitted.

    • [meta] String:Object optional

      Optional map of user-defined metadata to attach to this Texture.

    • [src=null] String optional

      Path to image file to load into this Texture. See the src property for more info.

    • [image=null] HTMLImageElement optional

      HTML Image object to load into this Texture. See the image property for more info.

    • [minFilter="linearMipmapLinear"] String optional

      How the texture is sampled when a texel covers less than one pixel. See the minFilter property for more info.

    • [magFilter="linear"] String optional

      How the texture is sampled when a texel covers more than one pixel. See the magFilter property for more info.

    • [wrapS="repeat"] String optional

      Wrap parameter for texture coordinate S. See the wrapS property for more info.

    • [wrapT="repeat"] String optional

      Wrap parameter for texture coordinate S. See the wrapT property for more info.

    • [flipY=false] Boolean optional

      Flips this Texture's source data along its vertical axis when true.

    • [translate=[0,0] Array of Number optional

      2D translation vector that will be added to texture's S and T coordinates.

    • [scale=[1,1] Array of Number optional

      2D scaling vector that will be applied to texture's S and T coordinates.

    • [rotate=0] Number optional

      Rotation, in degrees, that will be applied to texture's S and T coordinates.

    • [encoding="linear"] String optional

      Encoding format. See the encoding property for more info.

Methods

create

(
  • [cfg]
)

Convenience method for creating a Component within this Component's Scene.

The method is given a component configuration, like so:

var material = myComponent.create({
     type: "xeogl.PhongMaterial",
     diffuse: [1,0,0],
     specular: [1,1,0]
}, "myMaterial");

Parameters:

  • [cfg] optional

    Configuration for the component instance.

Returns:

:

destroy

()

Destroys this component.

Fires a destroyed event on this Component.

Automatically disassociates this component from other components, causing them to fall back on any defaults that this component overrode on them.

TODO: describe effect with respect to #create

error

(
  • message
)

Logs an error for this component to the JavaScript console.

The console message will have this format: [ERROR] [<component type> =<component id>: <message>

Also fires the message as an error event on the parent Scene.

Parameters:

  • message String

    The message to log

fire

(
  • event
  • value
  • [forget=false]
)

Fires an event on this component.

Notifies existing subscribers to the event, optionally retains the event to give to any subsequent notifications on the event as they are made.

Parameters:

  • event String

    The event type name

  • value Object

    The event parameters

  • [forget=false] Boolean optional

    When true, does not retain for subsequent subscribers

hasSubs

(
  • event
)
Boolean

Returns true if there are any subscribers to the given event on this component.

Parameters:

  • event String

    The event

Returns:

Boolean:

True if there are any subscribers to the given event on this component.

isType

(
  • type
)
Boolean

Tests if this component is of the given type, or is a subclass of the given type.

The type may be given as either a string or a component constructor.

This method works by walking up the inheritance type chain, which this component provides in property Component/superTypes:property, returning true as soon as one of the type strings in the chain matches the given type, of false if none match.

Examples:

var myRotate = new xeogl.Rotate({ ... });

myRotate.isType(xeogl.Component); // Returns true for all xeogl components
myRotate.isType("xeogl.Component"); // Returns true for all xeogl components
myRotate.isType(xeogl.Rotate); // Returns true
myRotate.isType(xeogl.Transform); // Returns true
myRotate.isType("xeogl.Transform"); // Returns true
myRotate.isType(xeogl.Mesh); // Returns false, because xeogl.Rotate does not (even indirectly) extend xeogl.Mesh

Parameters:

  • type String | Function

    Component type to compare with, eg "xeogl.PhongMaterial", or a xeogl component constructor.

Returns:

Boolean:

True if this component is of given type or is subclass of the given type.

log

(
  • message
)

Logs a console debugging message for this component.

The console message will have this format: [LOG] [<component type> <component id>: <message>

Also fires the message as a log event on the parent Scene.

Parameters:

  • message String

    The message to log

off

(
  • subId
)

Cancels an event subscription that was previously made with Component#on() or Component#once().

Parameters:

  • subId String

    Publication subId

on

(
  • event
  • callback
  • [scope=this]
)
String

Subscribes to an event on this component.

The callback is be called with this component as scope.

Parameters:

  • event String

    The event

  • callback Function

    Called fired on the event

  • [scope=this] Object optional

    Scope for the callback

Returns:

String:

Handle to the subscription, which may be used to unsubscribe with {@link #off}.

once

(
  • event
  • callback
  • [scope=this]
)

Subscribes to the next occurrence of the given event, then un-subscribes as soon as the event is subIdd.

This is equivalent to calling Component#on(), and then calling Component#off() inside the callback function.

Parameters:

  • event String

    Data event to listen to

  • callback Function(data)

    Called when fresh data is available at the event

  • [scope=this] Object optional

    Scope for the callback

warn

(
  • message
)

Logs a warning for this component to the JavaScript console.

The console message will have this format: [WARN] [<component type> =<component id>: <message>

Also fires the message as a warn event on the parent Scene.

Parameters:

  • message String

    The message to log

Properties

destroyed

Boolean

True as soon as this Component has been destroyed

encoding

String final

The Texture's encoding format.

flipY

Boolean final

Flips this Texture's source data along its vertical axis when true.

id

String final

Unique ID for this Component within its parent Scene.

image

HTMLImageElement

Indicates an HTML DOM Image object to source this Texture from.

Sets the src property to null.

Default: null

magFilter

String final

How this Texture is sampled when a texel covers more than one pixel.

Options are:

  • "nearest" - Uses the value of the texture element that is nearest (in Manhattan distance) to the center of the pixel being textured.
  • "linear" - (default) - Uses the weighted average of the four texture elements that are closest to the center of the pixel being textured.

Default: "linear"

metadata

Object

Arbitrary, user-defined metadata on this component.

minFilter

String final

How this Texture is sampled when a texel covers less than one pixel.

Options are:

  • "nearest" - Uses the value of the texture element that is nearest (in Manhattan distance) to the center of the pixel being textured.

  • "linear" - Uses the weighted average of the four texture elements that are closest to the center of the pixel being textured.

  • "nearestMipmapNearest" - Chooses the mipmap that most closely matches the size of the pixel being textured and uses the "nearest" criterion (the texture element nearest to the center of the pixel) to produce a texture value.

  • "linearMipmapNearest" - Chooses the mipmap that most closely matches the size of the pixel being textured and uses the "linear" criterion (a weighted average of the four texture elements that are closest to the center of the pixel) to produce a texture value.

  • "nearestMipmapLinear" - Chooses the two mipmaps that most closely match the size of the pixel being textured and uses the "nearest" criterion (the texture element nearest to the center of the pixel) to produce a texture value from each mipmap. The final texture value is a weighted average of those two values.

  • "linearMipmapLinear" - (default) - Chooses the two mipmaps that most closely match the size of the pixel being textured and uses the "linear" criterion (a weighted average of the four texture elements that are closest to the center of the pixel) to produce a texture value from each mipmap. The final texture value is a weighted average of those two values.

Default: "linearMipmapLinear"

model

Model final

The Model which contains this Component, if any.

Will be null if this Component is not in a Model.

rotate

Number

Rotation, in degrees, that will be applied to this Texture's S and T coordinates.

Default: 0

scale

Array(Number)

2D scaling vector that will be applied to this Texture's S and T coordinates.

Default: [1, 1]

scene

Scene final

The parent Scene that contains this Component.

src

String

Indicates a path to an image file to source this Texture from.

Sets the image property to null.

Default: null

translate

Array(Number)

2D translation vector that will be added to this Texture's S and T coordinates.

Default: [0, 0]

type

String final

JavaScript class name for this Component.

For example: "xeogl.AmbientLight", "xeogl.MetallicMaterial" etc.

wrapS

String final

Wrap parameter for this Texture's S coordinate.

Options are:

  • "clampToEdge" - causes S coordinates to be clamped to the size of the texture.
  • "mirroredRepeat" - causes the S coordinate to be set to the fractional part of the texture coordinate if the integer part of S is even; if the integer part of S is odd, then the S texture coordinate is set to 1 - frac ⁡ S , where frac ⁡ S represents the fractional part of S.
  • "repeat" - (default) - causes the integer part of the S coordinate to be ignored; xeogl uses only the fractional part, thereby creating a repeating pattern.

Default: "repeat"

wrapT

String final

Wrap parameter for this Texture's T coordinate.

Options are:

  • "clampToEdge" - Causes T coordinates to be clamped to the size of the texture.
  • "mirroredRepeat" - Causes the T coordinate to be set to the fractional part of the texture coordinate if the integer part of T is even; if the integer part of T is odd, then the T texture coordinate is set to 1 - frac ⁡ S , where frac ⁡ S represents the fractional part of T.
  • "repeat" - (default) - Causes the integer part of the T coordinate to be ignored; xeogl uses only the fractional part, thereby creating a repeating pattern.

Default: "repeat"

Events

destroyed

Fired when this Component is destroyed.