Visual 3D Objects
Mesh Rendering
Mesh Reference mesh_ref
Reference to a mesh to render (with submesh selection).
shadowCastingMode
Unsigned Byte
Default:1(On)
Min:0
Shadow casting mode for this mesh.
0Off1On
Shadow casting mode for this mesh.
submeshIndex
Integer
Default:0
Index of the submesh within the mesh's submesh array.
Index of the submesh within the mesh's submesh array.
value
UUID(mesh Asset)
Referenced mesh (UUID).
Referenced mesh (UUID).
Material Reference material_ref
Reference to a material to use for rendering.
faceCulling
Integer
Default:0(Inherit from material)
Face culling override: 0 = inherit from material, 1 = single-sided, 2 = double-sided.
0Inherit from material1Single Sided2Double Sided
Face culling override: 0 = inherit from material, 1 = single-sided, 2 = double-sided.
value
UUID(material Asset)
Referenced material (UUID).
Referenced material (UUID).
Mesh Reference mesh_ref
Reference to a mesh to render (with submesh selection).
shadowCastingMode
Unsigned Byte
Default:1(On)
Min:0
Shadow casting mode for this mesh.
0Off1On
Shadow casting mode for this mesh.
submeshIndex
Integer
Default:0
Index of the submesh within the mesh's submesh array.
Index of the submesh within the mesh's submesh array.
value
UUID(mesh Asset)
Referenced mesh (UUID).
Referenced mesh (UUID).
Material material
Assigns a shader to the entity's mesh and provides its input values and specialization constants.
constantsJSON
JSON
Specialization constants (JSON); schema defined by shaderRef.
Specialization constants (JSON); schema defined by shaderRef.
dataJSON
JSON
Shader input values (JSON); schema defined by shaderRef.
Shader input values (JSON); schema defined by shaderRef.
isDoubleSided
Boolean
Default:false
Render both front and back faces (double-sided).
Render both front and back faces (double-sided).
shaderRef
UUID(shader Asset)
Referenced shader (UUID).
Referenced shader (UUID).
Renders a mesh with morph targets, controlling their weights.
Mesh Reference mesh_ref
Reference to a mesh to render (with submesh selection).
shadowCastingMode
Unsigned Byte
Default:1(On)
Min:0
Shadow casting mode for this mesh.
0Off1On
Shadow casting mode for this mesh.
submeshIndex
Integer
Default:0
Index of the submesh within the mesh's submesh array.
Index of the submesh within the mesh's submesh array.
value
UUID(mesh Asset)
Referenced mesh (UUID).
Referenced mesh (UUID).
Morph Targets morph_targets
Contains weights assigned to morph targets of the mesh referred to by the entity's mesh_ref.
weights
Map<UUID, Float>
Map from morph target name to weight (commonly 0..1).
Map from morph target name to weight (commonly 0..1).
Material Reference material_ref
Reference to a material to use for rendering.
faceCulling
Integer
Default:0(Inherit from material)
Face culling override: 0 = inherit from material, 1 = single-sided, 2 = double-sided.
0Inherit from material1Single Sided2Double Sided
Face culling override: 0 = inherit from material, 1 = single-sided, 2 = double-sided.
value
UUID(material Asset)
Referenced material (UUID).
Referenced material (UUID).
Material material
Assigns a shader to the entity's mesh and provides its input values and specialization constants.
constantsJSON
JSON
Specialization constants (JSON); schema defined by shaderRef.
Specialization constants (JSON); schema defined by shaderRef.
dataJSON
JSON
Shader input values (JSON); schema defined by shaderRef.
Shader input values (JSON); schema defined by shaderRef.
isDoubleSided
Boolean
Default:false
Render both front and back faces (double-sided).
Render both front and back faces (double-sided).
shaderRef
UUID(shader Asset)
Referenced shader (UUID).
Referenced shader (UUID).
Decals
Creates a decal projector that projects a decal on meshes within the box volume.
Decal Projector decal_projector
Projects a material onto scene surfaces within the projector's box volume.
zIndex
Integer
Default:0
Z-index ordering for decal rendering; higher values render on top of lower ones.
Z-index ordering for decal rendering; higher values render on top of lower ones.
Box Geometry box_geometry
Box geometry.
dimension
Vector3(m)
Default:[1,1,1]
Box dimensions (width, height, depth) in meters.
Box dimensions (width, height, depth) in meters.
offset
Vector3(m)
Default:[0,0,0]
Local offset of the geometry origin (meters).
Local offset of the geometry origin (meters).
Material Reference material_ref
Reference to a material to use for rendering.
faceCulling
Integer
Default:0(Inherit from material)
Face culling override: 0 = inherit from material, 1 = single-sided, 2 = double-sided.
0Inherit from material1Single Sided2Double Sided
Face culling override: 0 = inherit from material, 1 = single-sided, 2 = double-sided.
value
UUID(material Asset)
Referenced material (UUID).
Referenced material (UUID).
Creates a decal projector that projects a decal on a specific mesh within the box volume.
Decal Projector decal_projector
Projects a material onto scene surfaces within the projector's box volume.
zIndex
Integer
Default:0
Z-index ordering for decal rendering; higher values render on top of lower ones.
Z-index ordering for decal rendering; higher values render on top of lower ones.
Box Geometry box_geometry
Box geometry.
dimension
Vector3(m)
Default:[1,1,1]
Box dimensions (width, height, depth) in meters.
Box dimensions (width, height, depth) in meters.
offset
Vector3(m)
Default:[0,0,0]
Local offset of the geometry origin (meters).
Local offset of the geometry origin (meters).
Material Reference material_ref
Reference to a material to use for rendering.
faceCulling
Integer
Default:0(Inherit from material)
Face culling override: 0 = inherit from material, 1 = single-sided, 2 = double-sided.
0Inherit from material1Single Sided2Double Sided
Face culling override: 0 = inherit from material, 1 = single-sided, 2 = double-sided.
value
UUID(material Asset)
Referenced material (UUID).
Referenced material (UUID).
Mesh Reference mesh_ref
Reference to a mesh to render (with submesh selection).
shadowCastingMode
Unsigned Byte
Default:1(On)
Min:0
Shadow casting mode for this mesh.
0Off1On
Shadow casting mode for this mesh.
submeshIndex
Integer
Default:0
Index of the submesh within the mesh's submesh array.
Index of the submesh within the mesh's submesh array.
value
UUID(mesh Asset)
Referenced mesh (UUID).
Referenced mesh (UUID).
Volume Rendering
Renders a volume with a shared volume material.
Volume Reference volume_ref
Reference to a volumetric dataset stored as a 3D texture (voxels).
texture3dRef
Referenced 3D texture (UUID) containing the volume voxels.
Referenced 3D texture (UUID) containing the volume voxels.
Volume Material Reference volume_material_ref
Reference to the volume material used for shading and transfer functions.
value
Referenced volume material (UUID).
Referenced volume material (UUID).
Renders a volume with a shared volume material and a filter to control how the volume is rendered.
Volume Reference volume_ref
Reference to a volumetric dataset stored as a 3D texture (voxels).
texture3dRef
Referenced 3D texture (UUID) containing the volume voxels.
Referenced 3D texture (UUID) containing the volume voxels.
Volume Material Reference volume_material_ref
Reference to the volume material used for shading and transfer functions.
value
Referenced volume material (UUID).
Referenced volume material (UUID).
Volume Filter volume_filter
View filtering and display controls applied to the referenced volume.
applyGaussianFiltering
Boolean
Default:false
Apply Gaussian smoothing when sampling voxels.
Apply Gaussian smoothing when sampling voxels.
enable3D
Boolean
Default:true
Whether this volume is visible in the 3D view.
Whether this volume is visible in the 3D view.
enableMPR
Boolean
Default:true
Whether this volume is visible in the MPR (multi-planar reconstruction) view.
Whether this volume is visible in the MPR (multi-planar reconstruction) view.
range
Vector2
Default:[0,1]
Displayed voxel intensity range [min, max]. Values outside the material's valid range are clamped/ignored.
Displayed voxel intensity range [min, max]. Values outside the material's valid range are clamped/ignored.
sampleUnfiltered
Boolean
Default:false
Sample texels without hardware filtering (nearest).
Sample texels without hardware filtering (nearest).
Point Cloud Rendering
Point Cloud Reference point_cloud_ref
Reference to a point cloud.
value
Referenced point cloud (UUID).
Referenced point cloud (UUID).
Geometry Culling
Culls all meshes, volumes and point clouds that are within the geometry’s bounds.
Culling Geometry culling_geometry
Enables culling using a simple analytic shape. Add alongside a geometry component (box, cylinder, plane, sphere).
isAdditive
Boolean
Default:true
Additive: show elements inside the geometry. Subtractive: show elements outside the geometry.
Additive: show elements inside the geometry. Subtractive: show elements outside the geometry.
Box Geometry box_geometry
Box geometry.
dimension
Vector3(m)
Default:[1,1,1]
Box dimensions (width, height, depth) in meters.
Box dimensions (width, height, depth) in meters.
offset
Vector3(m)
Default:[0,0,0]
Local offset of the geometry origin (meters).
Local offset of the geometry origin (meters).
Cylinder Geometry cylinder_geometry
Cylinder geometry.
axis
Integer
Default:1(Y-Axis)
Alignment axis of the cylinder: 0=X, 1=Y, 2=Z.
0X-Axis1Y-Axis2Z-Axis
Alignment axis of the cylinder: 0=X, 1=Y, 2=Z.
height
Float(m)
Default:1
Height of the cylinder (meters).
Height of the cylinder (meters).
offset
Vector3(m)
Default:[0,0,0]
Local offset of the geometry origin (meters).
Local offset of the geometry origin (meters).
radius
Float(m)
Default:0.5
Radius of the cylinder (meters).
Radius of the cylinder (meters).
Plane Geometry plane_geometry
Infinite plane geometry.
distance
Float(m)
Default:0
Signed distance from the origin along the plane normal (meters).
Signed distance from the origin along the plane normal (meters).
normal
Vector3
Default:[0,1,0]
Unit normal vector of the plane (in local space).
Unit normal vector of the plane (in local space).
Sphere Geometry sphere_geometry
Sphere geometry.
offset
Vector3(m)
Default:[0,0,0]
Local offset of the geometry origin (meters).
Local offset of the geometry origin (meters).
radius
Float(m)
Default:0.5
Radius of the sphere (meters).
Radius of the sphere (meters).