CanvasBreakpointsConstraint - Verge3D User Manual

A constraint allows to show/hide object depending on 3D viewport width/height or orientation settings.

Constraints are used to set up various relations between objects by affecting their position, rotation and scale. Can be used with the Object3D.constraints property.

Constructor

CanvasBreakpointsConstraint()

Properties

# .appInstance : App

# .isCanvasBreakpointsConstraint : Boolean

Used to check whether this or derived classes are canvas breakpoints constraints. Default is true.

# .maxHeight : Number

Maximum canvas height the object stays visible. Default is Infinity.

# .maxWidth : Number

Maximum canvas width the object stays visible. Default is Infinity.

# .minHeight : Number

Minimum canvas height the object stays visible. Default is 0.

# .minWidth : Number

Minimum canvas width the object stays visible. Default is 0.

# .orientation : String

Screen orientation the object stays visible. Default is "ALL".

"ALL"
"LANDSCAPE"
"PORTRAIT"

# .type : String

The constraint's type. Equals to "CanvasBreakpointsConstraint".

Methods

# .findAlternativeCamera (camera : Camera, scene : Scene, width : Number, height : Number) : Camera

camera — the current camera in scene.
scene — the scene in which we are looking for the camera.
width — the canvas width.
height — the canvas height.

Returns an alternative camera (with acceptable visibility breakpoints) in the scene, if no alternative camera is found, returns null.