Skip to content

GeometryVolumeBox

Box#

(GeometryVolumeBox)

  • Category: /Geometry/Volume
  • Default object name: box

Go to Technical page.

Description#

Creates a volume.

Attributes#

Name Type Description
Translate double[3] Set the XYZ position of the item relative to its parent item.
Rotate double[3] Set the XYZ rotation of the item relative to its parent item.
Scale double[3] Set the XYZ scaling of the item relative to its parent item.
Shear double[3] Set the XYZ shear of the item relative to its parent item.
Rotation Order long Specify on which order the Euler rotations are composed. By default Clarisse's uses YXZ
Parent reference (SceneItem) Set the parent item of the item.
Inherit Transform bool Does the current object inherits its parent transformation ?
Reference Frame long Set the reference frame that defines the base transform and deformation state of the item. This reference is used when computing texture projections or when generating point cloud (in Global Base) on the base geometry.
Constraints object[] (Constraint) Stack of constraint operators. Constraints like Target, Point, Orient... are applied to a Scene Item in order to drive the transformation of the item.
Scale Pivot double[3] Set the coordinates of the scale pivot.
Rotate Pivot double[3] Set the coordinates of the rotation pivot.
Translate Offset double[3] Set the XYZ position of the pivot point of the item.
Rotate Offset double[3] Set the XYZ rotation of the pivot point of the item.
Scale Offset double[3] Set the XYZ scaling of the pivot point of the item.
Rotation Offset Order long Set the rotation axis mode.
Display Visible bool Set whether the item is shown in the 3D View or not.
Display Pickable bool Set whether the item is pickable in the 3D View or in the Image View.
Display Color long Set the item color for constant or simple shading display in the 3D View.
Display Custom Color double[3] Set the item custom color used for display in the 3D View when the Display Color attribute is set to Custom.
Enable Motion Blur bool Set whether the renderer will do motion blur on the item or not.
Display Mode long Define how the object is displayed in the 3D View.
Highlight Mode long Define how the object is highlighted in the 3D View when selected.
Override Material reference (Material) Setting a material here will set the specified material to all elements of the scene object. Ex: all shading groups of a geometry will have the same material. Ex: all elements of a combiner or a scatterer will have the same material.
Matte Object bool Switch the object to 2D matte mode.
Matte Color double[3] Set the color of the object in matte mode.
Matte Alpha double Set the opacity of the object in matte mode. When the matte alpha is less than 100%, the object creates a hole in the layer as no transparency is evaluated.
Custom Id long
Raytrace Offset double Set the minimum distance for raytracing visibility. If the ray hit point distance from the ray source position is smaller than this value, then the geometry is not seen. Note: this attribute is used to prevent self intersection artifacts.
Shading Variables string
Unseen By Renderer bool Set whether the object is hidden from the renderer or not.
Unseen By Camera bool Set whether the object is hidden from the camera (primary rays) or not.
Unseen By Rays bool Set whether the object is hidden from the raytraced shading effects like reflection/refraction (secondary rays) or not.
Unseen By Reflections bool Set whether the object is hidden from reflections or not.
Unseen By Refractions bool Set whether the object is hidden from refractions or not.
Unseen By Gi bool Set whether the object is hidden from global illumination or not.
Unseen By Sss bool Set whether the object is hidden from sub-surface scattering or not.
Cast Shadows bool Set whether the object casts shadows or not.
Receive Shadows bool Set whether the object receives cast shadows or not.
Receive Self Shadows bool Set whether the object receives self shadows or not.
Lights reference (Group) Specify the group of lights that illuminate this object. By default, scene objects are lit using the lights gathered by the 3D layer.
Size double[3] Set the width, height and depth of the volume.
Density double Set the density of the volume.
Density Scale Compensation bool Maintain the optical, rather than physical, density of the volume at all geometry scales.
Density Offset double Value directly added to the density at evaluation.
Density Cutoff double Removes intersections with a density below this value in the 3D View.
Density Falloff curve[3] Control the falloff of the density on the 3 axes.
Step Mode long
Step Count long
Step Size double
Quality Mode long Control the sampling according to the distance. In constant mode, the step between samples is the same. In distance based mode, the steps vary according to the distance.
Camera Quality double Control the sampling for camera rays.
Reflection Quality double Control the sampling for reflection rays.
Refraction Quality double Control the sampling for refraction rays.
Shadow Quality double Control the sampling for shadow rays.
Global Illumination Quality double Control the sampling for global illumination rays.
Primary Rays Quality double Control the influence of the distance on sampling steps for primary rays (coming from a camera).
Secondary Rays Quality double Control the influence of the distance on sampling steps for secondary rays (reflection, refraction, shadows, global illumination, ...).