dash_mp_components.CrystalToolkitScene¶

Bases: Component

A CrystalToolkitScene component.

Keyword arguments:

children (optional):
First child will be rendered as the settings panel. Second child will be rendered as the bottom panel (legend).
id (optional):
The ID used to identify this component in Dash callbacks.
animation (optional):
Animation type.
axisView (optional):
Where is the axis displayed ( ‘NW’ / ‘NE’ / ‘SE’ / ‘SW’ / ‘HIDDEN’ ).
className (optional):
Class name that will wrap around the whole scene component. When enlarged, this class name is applied to the modal-content element.
currentCameraState (optional):
THIS PROP IS SET AUTOMATICALLY Object that maintains the current state of the camera. e.g. { position: {x: 0, y: 0, z: 0}, quarternion: {x: 0, y: 0, z: 0, w: 0}, zoom: 1, setByComponentId: “1”, following: True }.
customCameraState (optional):
Object for setting the scene to a custom camera state. When modified, the camera will update to new custom state. e.g. { position: {x: 0, y: 0, z: 0}, quarternion: {x: 0, y: 0, z: 0, w: 0}, (optional) zoom: 1 (optional) }.
data (optional):
Simple3DScene JSON, the easiest way to generate this is to use the Scene class in crystal_toolkit.core.scene and its to_json method.
debug (optional):
Display a debug view.
fileOptions (optional):
List of options to show in file download dropdown.
fileTimestamp (optional):
THIS PROP IS SET AUTOMATICALLY Date string that represents the time fileType was set. Use this prop in dash callbacks to trigger file downloads.
fileType (optional):
THIS PROP IS SET AUTOMATICALLY The last file type clicked in the file download menu.
imageData (optional):
THIS PROP IS SET AUTOMATICALLY Data string for the image generated on image button click.
imageDataTimestamp (optional):
THIS PROP IS SET AUTOMATICALLY Date string that represents the time imageData was set. Use this prop in dash callbacks to trigger downloads of imageData.
imageRequest (optional):
Set to trigger a screenshot or scene download. Must be an object with the following structure: { “filetype”: “png” // the image format (“png”, “dae”) } Passing this prop as an object ensures that new requests are triggered any time the prop is set.
imageType (optional):
File type to be downloaded as an image. Either png or dae.
inletPadding (optional):
Padding of the axis view.
inletSize (optional):
Size of the axis view.
sceneSize (optional):
Width / Height of the displayed component.
selectedObject (optional):
This points to the last clicked objects. Use it in your dash callback to know which objects are currently selected in the scene.
setProps (optional):
Dash-assigned callback that should be called whenever any of the properties change.
settings (optional):
Options used for generating scene. Supported options and their defaults are given as follows: { antialias: True, // set to False to improve performance renderer: ‘webgl’, // ‘svg’ also an option, used for unit testing transparentBackground: False, // transparent background background: ‘#ffffff’, // background color if not transparent, sphereSegments: 32, // decrease to improve performance cylinderSegments: 16, // decrease to improve performance staticScene: True, // disable if animation required defaultZoom: 1, // 1 will zoom to fit object exactly, <1 will add padding between object and box bounds zoomToFit2D: False // if True, will zoom to fit object only along the X and Y axes (not Z) extractAxis: False // will remove the axis from the main scene isMultiSelectionEnabled: False // allow to use shift to select, secondaryObjectView: True // show the selected object in a detail view animation: ‘play’ | ‘slider’ | ‘none’ // choose which style of animation is use } There are several additional options used for debugging and testing, please consult the source code directly for these.
showControls (optional)
showExpandButton (optional)
showExportButton (optional)
showImageButton (optional)
showPositionButton (optional)
toggleVisibility (optional):
Hide/show nodes in scene by its name (key), value is 1 to show the node and 0 to hide it.

__init__(children: str | int | float | Component | None | Sequence[str | int | float | Component | None] = None, id: str | dict | None = None, className: Any | None = None, data: Any | None = None, settings: Any | None = None, toggleVisibility: Any | None = None, imageRequest: Any | None = None, imageType: Any | None = None, imageData: Any | None = None, imageDataTimestamp: Any | None = None, fileOptions: Any | None = None, fileType: Any | None = None, fileTimestamp: Any | None = None, selectedObject: Any | None = None, sceneSize: Any | None = None, axisView: Any | None = None, inletSize: Any | None = None, inletPadding: Any | None = None, debug: Any | None = None, animation: Any | None = None, currentCameraState: Any | None = None, customCameraState: Any | None = None, showControls: Any | None = None, showExpandButton: Any | None = None, showImageButton: Any | None = None, showExportButton: Any | None = None, showPositionButton: Any | None = None, **kwargs)¶

Methods

`__init__`([children, id, className, data, ...])
`to_plotly_json`()

Attributes

`REQUIRED`
`UNDEFINED`
`available_wildcard_properties`

dash_mp_components.CrystalToolkitScene¶

dash-mp-components

Navigation

Related Topics