K4 Base Library   K4 Rule Objects
Copyright © 2021 by K4.org
  (v.0.48.124)

UIGeometryViewer (d.1.0)

Mixins: UIControlMixin, UIContainerMixin

A rectangular window showing scene geometry.

Index

Rules

Rules

VRSettings

VRSettings: Any

Expects an object that describes the settings for VR session. 'showVRButton' defines whether to show the VR button or not. 'userHeight' defines how far your headset will be above the floor in the model units. If not set then the 'local-floor' type of reference space will be used. 'startPoint' is the starting point of the reference space in the world. If not set then the scene camera position will be used.

example
{
showVRButton: true,
userHeight: 1750,
startPoint: p(0,0,0)
}

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

Expression : { showVRButton: false }

__model

__model: String

Internal Use Only.

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

Expression : R.UI.makeGeomViewer(Object.assign({}, this.spec, this.customSpec))

borderColor

borderColor: String

The color of the border lines

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

Expression : "black"

borderWeight

borderWeight: Number

The thickness of the border lines

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

Expression : 1

controlType

controlType: String

Internal Use Only

Flags : Cached (Note this is uncached)

Expression : "GeometryViewer"

defaultScene

defaultScene: String

The name of the initial scene being viewed.

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

Expression : "model"

faceNames

faceNames: Any

The view cube face names. If you want to override the default names use this object: { up: 'u', down: 'd', left: 'l', right: 'r', front: 'f', back: 'b' }.

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

Expression : {}

height

height: String

One of 'full', 'auto', 'half', '2x', '3x', or '5x'. The relative height of the control.

Flags : Cached, Parameter (Note this is uncached)

Expression : "fill"

instantUpdate

instantUpdate: Boolean

Only used wheninside a UIDialog. If true, bypasses the normal "update on OK" behavior of UIDialog, and will update the UI as soon as a change is made.

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

Expression : false

mouseMode

mouseMode: String

One of 'pan', 'orbit', 'zoom', 'drag'.

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

Expression : "orbit" //pan, zoom, drag

offsetSettings

offsetSettings: Any

The current offset control settings.

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

Expression : { title: 'Offset', labelX: 'X:', labelY: 'Y:', labelZ: 'Z:', hideUI: false }

selectionMode

selectionMode: String

One of 'single', 'multiple', 'multipleNoCtrlKey'.

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

Expression : "single"

selectionSet

selectionSet: Array

The current set of selected items.

Flags : Cached, Spec (Note this is uncached)

Expression : []

selectionSetBindParent

selectionSetBindParent: Any

The parent of the selectionSet binding rule.

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

Expression : this

selectionSetBindTarget

selectionSetBindTarget: String

The name of the selectionSet binding rule.

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

Expression : "selectionSet"

selectionSetItemType

selectionSetItemType: String

The data type of items in the 'selectionSet'. Default is 'refchain'. One of 'refchain': string, 'metadata': {refchain: string, oneOfMultiple?: boolean, patternInstanceId?: number}.

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

Expression : "refchain"

showBorder

showBorder: Boolean

Whether to show a border rectangle around the viewer.

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

Expression : false

showExportButton

showExportButton: Boolean

Whether to show the Export options button.

Flags : Cached, Parameter (Note this is uncached)

Expression : true

showFlags

showFlags: Number

Internal Use Only

Flags : Cached, Spec (Note this is uncached)

Expression : R.THREE.packShowFlags({border: this.showBorder, viewcube: this.showViewCube, exportbutton: this.showExportButton, jpgbutton: this.showJpgButton, pdfbutton: this.showPdfButton, objbutton: this.showObjButton, glbbutton: this.showGlbButton, gltfbutton: this.showGltfButton, toolbar: this.showToolbar, scenedropdown: this.showSceneDropdown})

showGlbButton

showGlbButton: Boolean

Whether to show the export GLB button.

Flags : Cached, Parameter (Note this is uncached)

Expression : true

showGltfButton

showGltfButton: Boolean

Whether to show the export GLTF button.

Flags : Cached, Parameter (Note this is uncached)

Expression : true

showJpgButton

showJpgButton: Boolean

Whether to show the export JPG button.

Flags : Cached, Parameter (Note this is uncached)

Expression : true

showObjButton

showObjButton: Boolean

Whether to show the export OBJ button.

Flags : Cached, Parameter (Note this is uncached)

Expression : true

showPdfButton

showPdfButton: Boolean

Whether to show the export PDF button.

Flags : Cached, Parameter (Note this is uncached)

Expression : true

showSceneDropdown

showSceneDropdown: Boolean

Whether to show the scene dropdown control.

Flags : Cached, Parameter (Note this is uncached)

Expression : true

showToolbar

showToolbar: Boolean

Whether to show the toolbar.

Flags : Cached, Parameter (Note this is uncached)

Expression : true

showViewCube

showViewCube: Boolean

Whether to show the view cube.

Flags : Cached, Parameter (Note this is uncached)

Expression : true

snapSettings

snapSettings: Any

The current snap settings

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

Expression : {size: 1.0, color: "yellow", highlightColor: "green", transparency: 0.5, visibleDistance: 5.0, snapDistance: 0.1 }

width

width: String

The width of the control. One of 'auto', 'fill', 'full', or exact values in percents ('10%') or pixels ('150px').

Flags : Cached, Parameter (Note this is uncached)

Expression : "fill"