add CrystalToolkitAnimationScene

dash_mp_components/CrystalToolkitAnimationScene.py

@@ -0,0 +1,193 @@
+# AUTO GENERATED FILE - DO NOT EDIT
+
+import typing  # noqa: F401
+from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401
+from dash.development.base_component import Component, _explicitize_args
+
+ComponentType = typing.Union[
+    str,
+    int,
+    float,
+    Component,
+    None,
+    typing.Sequence[typing.Union[str, int, float, Component, None]],
+]
+
+NumberType = typing.Union[
+    typing.SupportsFloat, typing.SupportsInt, typing.SupportsComplex
+]
+
+
+class CrystalToolkitAnimationScene(Component):
+    """A CrystalToolkitAnimationScene 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."""
+    _children_props = []
+    _base_nodes = ['children']
+    _namespace = 'dash_mp_components'
+    _type = 'CrystalToolkitAnimationScene'
+
+
+    def __init__(
+        self,
+        children: typing.Optional[ComponentType] = None,
+        id: typing.Optional[typing.Union[str, dict]] = None,
+        className: typing.Optional[typing.Any] = None,
+        data: typing.Optional[typing.Any] = None,
+        settings: typing.Optional[typing.Any] = None,
+        toggleVisibility: typing.Optional[typing.Any] = None,
+        imageRequest: typing.Optional[typing.Any] = None,
+        imageType: typing.Optional[typing.Any] = None,
+        imageData: typing.Optional[typing.Any] = None,
+        imageDataTimestamp: typing.Optional[typing.Any] = None,
+        fileOptions: typing.Optional[typing.Any] = None,
+        fileType: typing.Optional[typing.Any] = None,
+        fileTimestamp: typing.Optional[typing.Any] = None,
+        selectedObject: typing.Optional[typing.Any] = None,
+        sceneSize: typing.Optional[typing.Any] = None,
+        axisView: typing.Optional[typing.Any] = None,
+        inletSize: typing.Optional[typing.Any] = None,
+        inletPadding: typing.Optional[typing.Any] = None,
+        debug: typing.Optional[typing.Any] = None,
+        animation: typing.Optional[typing.Any] = None,
+        currentCameraState: typing.Optional[typing.Any] = None,
+        customCameraState: typing.Optional[typing.Any] = None,
+        showControls: typing.Optional[typing.Any] = None,
+        showExpandButton: typing.Optional[typing.Any] = None,
+        showImageButton: typing.Optional[typing.Any] = None,
+        showExportButton: typing.Optional[typing.Any] = None,
+        showPositionButton: typing.Optional[typing.Any] = None,
+        **kwargs
+    ):
+        self._prop_names = ['children', 'id', 'animation', 'axisView', 'className', 'currentCameraState', 'customCameraState', 'data', 'debug', 'fileOptions', 'fileTimestamp', 'fileType', 'imageData', 'imageDataTimestamp', 'imageRequest', 'imageType', 'inletPadding', 'inletSize', 'sceneSize', 'selectedObject', 'setProps', 'settings', 'showControls', 'showExpandButton', 'showExportButton', 'showImageButton', 'showPositionButton', 'toggleVisibility']
+        self._valid_wildcard_attributes =            []
+        self.available_properties = ['children', 'id', 'animation', 'axisView', 'className', 'currentCameraState', 'customCameraState', 'data', 'debug', 'fileOptions', 'fileTimestamp', 'fileType', 'imageData', 'imageDataTimestamp', 'imageRequest', 'imageType', 'inletPadding', 'inletSize', 'sceneSize', 'selectedObject', 'setProps', 'settings', 'showControls', 'showExpandButton', 'showExportButton', 'showImageButton', 'showPositionButton', 'toggleVisibility']
+        self.available_wildcard_properties =            []
+        _explicit_args = kwargs.pop('_explicit_args')
+        _locals = locals()
+        _locals.update(kwargs)  # For wildcard attrs and excess named props
+        args = {k: _locals[k] for k in _explicit_args if k != 'children'}
+
+        super(CrystalToolkitAnimationScene, self).__init__(children=children, **args)
+
+setattr(CrystalToolkitAnimationScene, "__init__", _explicitize_args(CrystalToolkitAnimationScene.__init__))

src/lib/components/crystal-toolkit/CrystalToolkitAnimationScene.react.js

@@ -0,0 +1,174 @@
+import * as mp from '@materialsproject/mp-react-components';
+import React, {Component} from 'react';
+
+export default class CrystalToolkitAnimationScene extends Component {
+    render() {
+        return (
+            <mp.CrystalToolkitAnimationScene
+                {...this.props}
+                onObjectClicked={o => {
+                    this.props.setProps({selectedObject: o});
+                }}
+            />
+        );
+    }
+}
+
+CrystalToolkitAnimationScene.propTypes = {
+    /**
+     * The ID used to identify this component in Dash callbacks
+     */
+    id: PropTypes.string,
+    /**
+     * Dash-assigned callback that should be called whenever any of the
+     * properties change
+     */
+    setProps: PropTypes.func,
+    /**
+     * First child will be rendered as the settings panel.
+     * Second child will be rendered as the bottom panel (legend).
+     */
+    children: PropTypes.node,
+    /**
+     * Class name that will wrap around the whole scene component.
+     * When enlarged, this class name is applied to the modal-content element.
+     */
+    className: PropTypes.string,
+    /**
+     * Simple3DScene JSON, the easiest way to generate this is to use the Scene class
+     * in crystal_toolkit.core.scene and its to_json method.
+     */
+    data: PropTypes.object,
+    /**
+     * 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.
+     */
+    settings: PropTypes.object,
+    /**
+     * Hide/show nodes in scene by its name (key), value is 1 to show the node
+     * and 0 to hide it.
+     */
+    toggleVisibility: PropTypes.object,
+    /**
+     * 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.
+     */
+    imageRequest: PropTypes.object,
+    /**
+     * THIS PROP IS SET AUTOMATICALLY
+     * Data string for the image generated by imageRequest
+     * This string can be downloaded as the filetype specified in your imageRequest object
+     */
+    /**
+     * File type to be downloaded as an image. Either png or dae
+     */
+    imageType: PropTypes.oneOf(['png', 'dae']),
+    /**
+     * THIS PROP IS SET AUTOMATICALLY
+     * Data string for the image generated on image button click
+     */
+    imageData: PropTypes.string,
+    /**
+     * 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.
+     */
+    imageDataTimestamp: PropTypes.any,
+    /**
+     * List of options to show in file download dropdown
+     */
+    fileOptions: PropTypes.array,
+    /**
+     * THIS PROP IS SET AUTOMATICALLY
+     * The last file type clicked in the file download menu
+     */
+    fileType: PropTypes.string,
+    /**
+     * THIS PROP IS SET AUTOMATICALLY
+     * Date string that represents the time fileType was set.
+     * Use this prop in dash callbacks to trigger file downloads.
+     */
+    fileTimestamp: PropTypes.any,
+    /**
+     * This points to the last clicked objects. Use it in your dash callback
+     * to know which objects are currently selected in the scene
+     *
+     */
+    selectedObject: PropTypes.array,
+    /**
+     * Width / Height of the displayed component
+     */
+    sceneSize: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+    /**
+     * Where is the axis displayed ( 'NW' / 'NE' / 'SE' / 'SW' / 'HIDDEN' )
+     */
+    axisView: PropTypes.string,
+    /**
+     * Size of the axis view
+     */
+    inletSize: PropTypes.number,
+    /**
+     * Padding of the axis view
+     */
+    inletPadding: PropTypes.number,
+    /**
+     * Display a debug view
+     */
+    debug: PropTypes.bool,
+    /**
+     * Animation type
+     */
+    animation: PropTypes.string,
+    /**
+     * 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
+     * }
+     */
+    currentCameraState: PropTypes.object,
+    /**
+     * 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)
+     * }
+     */
+    customCameraState: PropTypes.object,
+    showControls: PropTypes.bool,
+    showExpandButton: PropTypes.bool,
+    showImageButton: PropTypes.bool,
+    showExportButton: PropTypes.bool,
+    showPositionButton: PropTypes.bool,
+};