Class: PaperElement3D

PaperElement3D

new PaperElement3D(element, frontopt, backopt)

The PaperElement3D class is a type of Element3D which is meant to hold 2 child DOM elements which represent a front and a back which show depending on which way the object is faicing in 3D space. Basically a 2 sided element.

In automatic scene creation based on the DOM this class is automatically created for any element with a CSS class dom3d-paperelement3d and any direct child elements with the class names dom3d-front and dom3d-back will automatically be set up as the object's front and back.
Parameters:
Name Type Attributes Description
element An argument identifying the HTML Element the display object is to associate with. Can be the actual element itself, an HTML string representing an element to create, or a query selector string which will identify the intended HTML element already in the DOM.
front <optional>
An argument identifying an HTML Element that is meant to be this object's front side. Can be the actual element itself, an HTML string representing an element to create, or a query selector string which will identify the intended HTML element already in the DOM.
back <optional>
An argument identifying an HTML Element that is meant to be this object's back side. Can be the actual element itself, an HTML string representing an element to create, or a query selector string which will identify the intended HTML element already in the DOM.
Source:

Extends

Members

back :HTMLElement

Set to an HTML Element child of this one which will show when its back is facing forward.
Type:
  • HTMLElement
Default Value:
  • null
Source:

(readonly) element :HTMLElement

Every DisplayObject3D represents an HTML Element. You can access that element by accessing the object's element property. Conversely any element that has an associated DisplayObject3D will have a property .dom3dObject which references its DisplayObject3D.
Type:
  • HTMLElement
Inherited From:
Default Value:
  • null
Source:

front :HTMLElement

Set to an HTML Element child of this one which will show when its front is facing forward.
Type:
  • HTMLElement
Default Value:
  • null
Source:

(readonly) frontFacing :Boolean

Used to read whether the object considers itself front-facing at the moment.
Type:
  • Boolean
Default Value:
  • true
Source:

id :String

Each DisplayObject3D has a unique id property. When the element it represents has an id attribute at the time of instantiation it will match its element's id. Otherwise a unique one will be generated. You can also assign your own.
Type:
  • String
Inherited From:
Default Value:
  • ""
Source:

(readonly) isDisplayObject3D :Boolean

Any dom3d object meant to be part of the display list/stage will have this property as true.
Type:
  • Boolean
Inherited From:
Default Value:
  • true
Source:

(readonly) isPaperElement3D :Boolean

A PaperElement3D will have an isPaperElement3D property of true for identification purposes. isDisplayObject3D (which is inherited) will also exist as a uniform way to identify dom3d display objects in general.
Type:
  • Boolean
Default Value:
  • true
Source:

(readonly) parent :DisplayObject3D

Each DisplayObject3D has a parent property that allows it to tell which object is currently this object's parent in the display list. Null if it is not in the display list.
Type:
Inherited From:
Default Value:
  • null
Source:

rotX :Number

The rotX property sets the x-axis rotation value for the DisplayObject3D instance in degrees.

This property can be set automatically upon instantiation by having a data-rotX attribute on the element set to a number.
Type:
  • Number
Inherited From:
Default Value:
  • 0
Source:

rotY :Number

The rotY property sets the y-axis rotation value for the DisplayObject3D instance in degrees.

This property can be set automatically upon instantiation by having a data-rotY attribute on the element set to a number.
Type:
  • Number
Inherited From:
Default Value:
  • 0
Source:

rotZ :Number

The rotZ property sets the z-axis rotation value for the DisplayObject3D instance in degrees.

This property can be set automatically upon instantiation by having a data-rotZ attribute on the element set to a number.
Type:
  • Number
Inherited From:
Default Value:
  • 0
Source:

(readonly) stage3D :Stage3D

Each DisplayObject3D has a stage3D property that allows it to tell which stage it is currently in the display list of. Is null when not in a display list.
Type:
Inherited From:
Default Value:
  • null
Source:

(readonly) type :String

A PaperElement3D will have a type property of "PaperElement3D" for identification purposes.
Type:
  • String
Default Value:
  • "PaperElement3D"
Source:

x :Number

The x property sets the x coordinate value for the DisplayObject3D instance.

This property can be set automatically upon instantiation by either having a CSS style left property set in pixels, or a data-x attribute on the element set to a number.
Type:
  • Number
Inherited From:
Default Value:
  • 0
Source:

y :Number

The y property sets the y coordinate value for the DisplayObject3D instance.

This property can be set automatically upon instantiation by either having a CSS style top property set in pixels, or a data-y attribute on the element set to a number.
Type:
  • Number
Inherited From:
Default Value:
  • 0
Source:

z :Number

The z property sets the z coordinate value for the DisplayObject3D instance.

This property can be set automatically upon instantiation by having a data-z attribute on the element set to a number.
Type:
  • Number
Inherited From:
Default Value:
  • 0
Source:

Methods

setX(value) → {DisplayObject3D}

setX (and likewise the setY, setZ, setRotX, setRotY, and setRotZ which are not documented because they operate the same as setX but for their respective properties) is a method that allows you to set the x coordinate value in a chainable way like is familiar in libraries such as jQuery. So myObj.setX(20).setY(20); is legitimate to set the x and y to 20. It also allows relative changes via a string using operators, such as "+=20", "*=2" or just "++" and "--" increments. This is much slower than just setting the properties, but useful nonetheless in some situations.
Parameters:
Name Type Description
value Number | String The new number value to set it to, or the string indicating the relative change to happen.
Inherited From:
Source:
Returns:
Returns this DisplayObject3D for chaining purposes.
Type
DisplayObject3D