import {Plane} from 'infamous/src/legacy/Plane.js'

public class | source

Plane

Extends:

* → Plane

Planes have the properties of Molecules, plus they contain a famous/src/core/Surface so that they ultimately render onto the screen. A Surface's events are automatically piped to it's famous/src/core/EventHandler, inherited from Molecule.

Constructor Summary

Public Constructor
public	constructor(initialOptions: Object) Creates a new `Plane`.

Member Summary

Public Members
public	surface: *

Method Summary

Public Methods
public	getContent(): * Get the content of this Plane's famous/src/core/Surface. See famous/src/core/Surface.getContent.
public	setContent(): * Set the content of this Plane's famous/src/core/Surface. See famous/src/core/Surface.setContent.

Public Constructors

public constructor(initialOptions: Object) source

Creates a new Plane. Properties from the initialOptions parameter are applied to this Plane's famous/src/core/Surface as well as to to this Plane's famous/src/core/Modifier, hence the API of a Plane is currently the combination of the Famo.us Modifier and Surface APIs.

Params:

Name	Type	Attribute	Description
initialOptions	Object		Options for the new Plane.

Public Members

public surface: * source

Public Methods

public getContent(): * source

Get the content of this Plane's famous/src/core/Surface. See famous/src/core/Surface.getContent.

Return:

public setContent(): * source

Set the content of this Plane's famous/src/core/Surface. See famous/src/core/Surface.setContent.