Copyright © 2021 by K4.org
  (v.0.48.124)

A Scene is a modelling/rendering environment. A model can only exist in one scene.

Index

Rules

PDFname

PDFname: String

The name of the PDF file generated when the generate PDF button is pressed

Flags : Cached, Parameter (Note this is uncached)

Expression : ${R.rootModel.name}-${this.sceneName}.pdf

__mod3

__mod3: String

Internal Use Only.

Flags : Cached, External, Update (Note this is uncached)

Expression : R.THREE.makeScene(this.sceneName, this.spec)

background

background: String

The background color or url for the scene. If 'transparent' is given, the background will not show.

Flags : Cached, Parameter (Note this is uncached)

Expression : "0xebf8f7"

backgroundType

backgroundType: String

One of 'color', 'image', 'environment'. For 'image', 'environment' the background property should contain the texture url.

Flags : Cached, Parameter (Note this is uncached)

Expression : "color"

camera

camera: Model

The camera/view to use as the starting render. Thereafter, the user has control over the view. This defines the 'home view' of the scene.

Flags : Cached, Parameter (Note this is uncached)

Expression : R.world.RenderLibrary.Views.Iso

edgeStyle

edgeStyle: Any

Defines the styling of the edge geometry. See LineMaterial for more information. All possible options:

{ edgeWeight: 1, // lineWeight of the visible edges. Default is 1. edgeColor: 'black', // color of the visible edges. Default is 'black'. hiddenEdgeWeight: 1, // lineWeight of the hidden edges. Default is 1. hiddenEdgeColor: 'gray', // color of the hidden edges. Default is 'gray'. hiddenEdgeDashPattern: [10,5] // dash pattern of the hidden edges. Default is [10,5]. }

Flags : Cached, Parameter (Note this is uncached)

Expression : undefined

enableShadows

enableShadows: Boolean

[NYI] Whether shadows should be cast in this scene. If true, shadows still require lights that can cast them and objects that can accept them.

Flags : Cached, Parameter (Note this is uncached)

Expression : true

environment

environment: Any

If not null, this equirectangular texture is set as the environment map for all physical materials in the scene. May be a Resource, URL, or server file path.

Flags : Cached, Parameter (Note this is uncached)

Expression : null

environmentUrl

environmentUrl: Any

Internal Use Only.

Flags : Cached (Note this is uncached)

Expression : this.environment ? R.getUrl(this.environment) : null

fog

fog: Any

Contains the parameters that define Linear Fog and Exponential Squared Fog. None by default.

example
{ type: 'exponential', color: 0xB4A953, density: 0.00025 }

{ type: 'linear', color: 'green', near: 1, far: 1000 }

Flags : Cached, Parameter (Note this is uncached)

Expression : {}

isDrawing

isDrawing: Boolean

Whether the scene is being used to show a DrawingSheet.

Flags : Cached, Parameter (Note this is uncached)

Expression : false

paperHeight

paperHeight: Number

The vertical size of the 'paper' being used for drawing scenes. Ignored otherwise.

Flags : Cached, Parameter (Note this is uncached)

Expression : 10

paperUnits

paperUnits: String

One of 'in', 'mm', or 'cm'. The units to be used in drawing scenes.

Flags : Cached, Parameter (Note this is uncached)

Expression : "in"

paperWidth

paperWidth: Number

The horizontal size of the 'paper' being used for drawing scenes. Ignored otherwise.

Flags : Cached, Parameter (Note this is uncached)

Expression : 10

renderStyle

renderStyle: String

One of 'default', 'wireframe', 'shaded', 'shadedEdges', 'hiddenLine', or 'hiddenLineDashed'. Default is equivalent to shadedEdges.

Flags : Cached, Parameter (Note this is uncached)

Expression : "default"

sceneLabel

sceneLabel: String

The text to be used to represent the scene in various UI aspects, such as the scene drop-down menu.

Flags : Cached, Parameter (Note this is uncached)

Expression : this.sceneName

sceneName

sceneName: String

The name to reference the scene. Cannot include spaces or special characters.

If you use a name already in use, for example 'model', your definition will override the system default.

Flags : Cached, Required, Parameter (Note this is uncached)

Expression : ``

spec

spec: Any

Internal Use Only.

Flags : Cached (Note this is uncached)

Expression : {sceneName: this.sceneName, label: this.scenelabel, environmentUrl: this.environmentUrl, background: this.background, backgroundType: this.backgroundType, use2DControls: this.use2DControls, useDefaultLights: this.useDefaultLights, renderStyle: this.renderStyle, edgeStyle: this.edgeStyle, paperHeight: this.paperHeight, paperWidth: this.paperWidth, paperUnits: this.paperUnits, pdfName: this.pdfName, worldUp: this.worldUp, cameraSpec: this.camera.spec, fogSpec: this.fog}

use2DControls

use2DControls: Boolean

Whether to use 2D graphic controls when displaying the scene.

Flags : Cached, Parameter (Note this is uncached)

Expression : this.isDrawing

useDefaultLights

useDefaultLights: Boolean

Whether the standard, system-defined lighting should be included in the scene. If true and additional Lights are added, they will be added in addition to the standard lights. To have complete control over lighting, set this to false.

Flags : Cached, Parameter (Note this is uncached)

Expression : true

worldUp

worldUp: Vector

The vector which defines the "up" direction of the world. Used to align with external systems which may use a different default direction. This only affects the visualization of the world.

Flags : Cached, Parameter (Note this is uncached)

Expression : R.world.unitZ