MRImageEntity

MRImageEntity ⇐ MRMediaEntity

Base html image represented in 3D space. mr-image

Kind: global class
Extends: MRMediaEntity

• MRImageEntity ⇐ MRMediaEntity
  • .MRImageEntity
    • new exports.MRImageEntity()
  • .mediaWidth() ⇒ number
  • .mediaHeight() ⇒ number
  • .connected()
  • .loadMediaTexture()
  • .mutated(mutation)

mrImageEntity.MRImageEntity

Kind: instance class of MRImageEntity

new exports.MRImageEntity()

Constructs a base image entity using a UIPlane and other 3D elements as necessary.

mrImageEntity.mediaWidth() ⇒ number

Gets the width of the internal media object

Kind: instance method of MRImageEntity
Returns: number - width - the value of the width

mrImageEntity.mediaHeight() ⇒ number

Gets the height of the internal media object

Kind: instance method of MRImageEntity
Returns: number - height - the value of the height

mrImageEntity.connected()

(async) handles setting up this Image and associated 3D geometry style (from css) once it is connected to run as an entity component.

Kind: instance method of MRImageEntity

mrImageEntity.loadMediaTexture()

Loads the Media texture of the setup this.media object based on its html source info.

Kind: instance method of MRImageEntity

mrImageEntity.mutated(mutation)

Callback function of MREntity - Updates the image’s cover,fill,etc based on the mutation request.

Kind: instance method of MRImageEntity

Param	Type	Description
mutation	object	the update/change/mutation to be handled.