Visual 3D Objects

Mesh Rendering

• Mesh Reference
  Entity Component

  Mesh Reference mesh_ref

  Reference to a mesh.

  Schema

  shadowCastingMode

  Unsigned Byte

  Default: [1] On

  [0] Off [1] On

  Whether or not this mesh casts shadows.

  submeshIndex

  Integer

  Default: 0

  Index of the submesh inside the mesh's submesh array.

  value

  Asset UUID

  UUID of the referenced mesh.

  View in reference
  ,
  Material Reference
  Entity Component

  Material Reference material_ref

  Reference to a material.

  Schema

  faceCulling

  Integer

  Default: [0] Inherit from material

  [0] Inherit from material [1] Single Sided [2] Double Sided

  Face culling mode. 0 to inherit from material, 1 for single sided, 2 for double sided.

  value

  Asset UUID

  UUID of the referenced material.

  View in reference
  : renders a mesh with a shared material

  • + morph_targets: if mesh has morph targets, then controls their weights

• Mesh Reference
  Entity Component

  Mesh Reference mesh_ref

  Reference to a mesh.

  Schema

  shadowCastingMode

  Unsigned Byte

  Default: [1] On

  [0] Off [1] On

  Whether or not this mesh casts shadows.

  submeshIndex

  Integer

  Default: 0

  Index of the submesh inside the mesh's submesh array.

  value

  Asset UUID

  UUID of the referenced mesh.

  View in reference
  ,
  Material
  Entity Component

  Material material

  References a shader and specifies input values if needed.

  Schema

  constantsJSON

  JSON

  Specialization constants values as described in the referenced shader in their original JSON format.

  dataJSON

  JSON

  Input values as described in the referenced shader in their original JSON format.

  isDoubleSided

  Boolean

  Default: false

  Whether the material is double sided or not.

  shaderRef

  Asset UUID

  UUID of the referenced shader.

  View in reference
  : renders a mesh with a unique material

  • + morph_targets: if mesh has morph targets, then controls their weights

Decals

• Decal Projector
  Entity Component

  Decal Projector decal_projector

  Decal Projector.

  Schema

  zIndex

  Integer

  Default: 0

  Z-Index order of the decal projection. The higher index will render on top of the lower ones.

  View in reference
  ,
  Box Geometry
  Entity Component

  Box Geometry box_geometry

  Box geometry.

  Schema

  dimension

  Vector3

  Default: [1,1,1]

  Width, height and depth of the box.

  offset

  Vector3

  Default: [0,0,0]

  Geometry offset.

  View in reference
  ,
  Material Reference
  Entity Component

  Material Reference material_ref

  Reference to a material.

  Schema

  faceCulling

  Integer

  Default: [0] Inherit from material

  [0] Inherit from material [1] Single Sided [2] Double Sided

  Face culling mode. 0 to inherit from material, 1 for single sided, 2 for double sided.

  value

  Asset UUID

  UUID of the referenced material.

  View in reference
  : creates a decal

• Mesh Reference
  Entity Component

  Mesh Reference mesh_ref

  Reference to a mesh.

  Schema

  shadowCastingMode

  Unsigned Byte

  Default: [1] On

  [0] Off [1] On

  Whether or not this mesh casts shadows.

  submeshIndex

  Integer

  Default: 0

  Index of the submesh inside the mesh's submesh array.

  value

  Asset UUID

  UUID of the referenced mesh.

  View in reference
  : projects a decal on this mesh

Volume Rendering

• Volume Reference
  Entity Component

  Volume Reference volume_ref

  Reference to a volume made of voxels.

  Schema

  texture3dRef

  Asset UUID

  UUID of the referenced 3D texture.

  View in reference
  ,
  Volume Material Reference
  Entity Component

  Volume Material Reference volume_material_ref

  Reference to a material to use with a volume.

  Schema

  value

  Asset UUID

  UUID of the referenced volume material.

  View in reference
  : renders a volume

• Volume Filter
  Entity Component

  Volume Filter volume_filter

  Filtering properties applied to the volume.

  Schema

  applyGaussianFiltering

  Boolean

  Default: false

  Apply gaussian filtering on voxels.

  enable3D

  Boolean

  Default: true

  Whether or not this volume is visible in the 3D view.

  enableMPR

  Boolean

  Default: true

  Whether or not this volume is visible in the MPR view.

  range

  Vector2

  Default: [0,1]

  Voxel intensity range displayed, not applicable if outside volume material range.

  sampleUnfiltered

  Boolean

  Default: false

  Are texel values from the voxel texture sampled unfiltered.

  View in reference
  : controls how the volume will be rendered

Point Cloud Rendering

• Point Cloud Reference
  Entity Component

  Point Cloud Reference point_cloud_ref

  Reference to a point cloud.

  Schema

  value

  Asset UUID

  UUID of the referenced point cloud.

  View in reference
  : renders a point cloud

Geometry Culling

• *_geometry,
  Culling Geometry
  Entity Component

  Culling Geometry culling_geometry

  Culling geometry. Add this component in addition to another geometry component (e.g. box geometry, sphere geometry, etc.) to enable culling geometry.

  Schema

  isAdditive

  Boolean

  Default: true

  Additive geometry will only display elements (vertices or voxels) inside the geometry. Subtractive will only display elements outside the geometry.

  View in reference
  : culls all meshes, volumes and point clouds that are within the geometry’s bounds