Skip to main content

<set-view-volumetric>

This components performs a volumetric rendering by ray casting of the volume loaded in the workspace. `set-view-volumetric` only has one **required** property, that is, the `workspace`, the rest of the properties are optional. This component can be used in standalone, or as part of `<set-pane>`.

Properties

NameDocsTypeDefault value
ambientColorSet the ambient ilumination in the phong reflection model. It should be a RGBA value, and applies only when the active shader is realistic. For further information: https://en.wikipedia.org/wiki/Phong_reflection_model[number, number, number, (number | undefined)?] | string[255, 255, 255, 63]
autoRotateWhen `true` or positive integer, the camera keeps rotating automatically. When a number, it specifies the rotation speed.boolean | numberfalse
backgroundBackground color of the 3D scene.string"#000000"
cameraPositionSets camera positionPoint{ x: 0, y: 0.9, z: 0, }
cameraTarget"center" | "crosshair" | Point"center"
colormapA description of the colormap texture used by the volumetric render to map certain volume values to specific colors. Look at the ColorMap docs for further information.GradientBitmap | GradientLinear | GradientMaterials | undefined
cutHighUpper cut of the maximun intensity shader. Volume data over this value will be excluded in the rendering phase.numberMAX_HU
cutLowLower cut of the maximun intensity shader. Volume data under this value will be excluded in the rendering phase.numberMIN_HU
dampingWhen `true`, the camera movement has a damping effect. When a number, it specifies the damping factor.boolean | numberfalse
diffuseColorSet the diffuse ilumination in the phong reflection model. It should be a RGBA value, and applies only when the active shader is realistic. For further information: https://en.wikipedia.org/wiki/Phong_reflection_model[number, number, number, (number | undefined)?] | string[255, 255, 255, 165]
filterVolumeIf `true`, the volume data used by the volumetric render will use a filtered version using a 3-dimensional gaussian blur, this setting is recommended since it usually smooths the result, cleaning noise.boolean | undefined
fragmentShaderCustom GLSL fragment shared, replaces the one specified by the `shader` property.string | undefined
maxDistancenumber1.6
middleActionAction to performance when moving the middle pointer. Middle click. Does not have an effect on mobile."none" | "pan" | "rotate" | "zoom""zoom"
minDistancenumber0.1
panSpeedSets how fast the 3D model translates. From `0` to `Infinite`.number0.2
pixelRatioRepresent the pixel ratio used by the renderer.numbergetFastDevice() ? 1 : 0.5
pointerActionAction to performance when moving the main pointer. Left click or a single touch."none" | "pan" | "rotate" | "zoom""rotate"
rayStepsSpecified the amount of steps taken by the volumetric ray casting algorithm. Defaults to "adaptive", which dynamically adapts the number of steps to improve responsiveness."adaptive" | number"adaptive"
rotateSpeedSets how fast the 3D model rotates. From `0` to `Infinite`.number1
secondaryActionAction to performance when moving the secondary pointer. Right click or two touches."none" | "pan" | "rotate" | "zoom""pan"
shaderThere are two built-in typees of volumetric render: - "realistic": real word physics and ilumuntation. - "max-intensity": maps only the highest intensity."basic" | "lighting" | "max-intensity" | "shadows""lighting"
showAxesRender the axis helper in the 3D space.booleanfalse
showBoundingBoxRender the bounding box of the volumen data.booleanfalse
showGeometriesRender the 3D geometry included in the workspace.booleantrue
showPlanesRender workspace planes. By default, no plane is rendered.ProjectionNames[][]
showProjectionCubeRender the projection cubebooleanfalse
showShapesRender 2D annotations in the 3D spaces. Lines, areas and points.booleantrue
specularColorSet the specuular ilumination in the phong reflection model. It should be a RGBA value, and applies only when the active shader is realistic. For further information: https://en.wikipedia.org/wiki/Phong_reflection_model[number, number, number, (number | undefined)?] | string[255, 255, 255, 51]
workspaceWorkspace to visualize.Workspace | string | undefined | { id: string; }
zoomCamera zoom. The greater this value becomes, the closer is the camera to the center of the model.number1.0
zoomSpeedSets how fast the zoom moves. From `0` to `Infinite`.number0.3

Events

NameDocsType
setStateChange

CSS parts

NameDocs
error
loading