GeometryUsdCube

GeometryUsdCube#

(Usd Cube)

Abstract Class
Category: /Geometry
Default object name: usd_cube
Inherits from: ProjectItem > SceneItem > SceneObject > Geometry

No corresponding User page.

Description#

USD cube reference.

Public Attributes#

Type	Name	Visual Hint	Description
`string`	`prim_path`	`VISUAL_HINT_DEFAULT`	Prim path in the USD stage.
`string`	`purpose`	`VISUAL_HINT_DEFAULT`	Purpose of this prim.
`long`	`frame`	`VISUAL_HINT_FRAME`	Define the frame value used to evaluate the geometry.
`long`	`frame_offset`	`VISUAL_HINT_FRAME`	Define the frame offset. Example: if the frame offset is 50 while the animation starts at frame 10, then it will start at frame 60.
`long`	`animation_behavior`	`VISUAL_HINT_DEFAULT`	Define the animation loop behavior.
`bool`	`force_animation_range`	`VISUAL_HINT_DEFAULT`	Enable the defined animation range, used to override the object's original animation range.
`long[2]`	`animation_range`	`VISUAL_HINT_FRAME`	Start and end frames for the animation.

Inherited Public Attributes#

Type	Name	Visual Hint	Description
`double[3]`	`translate`	`VISUAL_HINT_DISTANCE`	Set the XYZ position of the item relative to its parent item.
`double[3]`	`rotate`	`VISUAL_HINT_ANGLE`	Set the XYZ rotation of the item relative to its parent item.
`double[3]`	`scale`	`VISUAL_HINT_SCALE`	Set the XYZ scaling of the item relative to its parent item.
`double[3]`	`shear`	`VISUAL_HINT_SCALE`	Set the XYZ shear of the item relative to its parent item.
`long`	`rotation_order`	`VISUAL_HINT_DEFAULT`	Specify on which order the Euler rotations are composed. By default Clarisse's uses YXZ
`reference` (`SceneItem`)	`parent`	`VISUAL_HINT_DEFAULT`	Set the parent item of the item.
`bool`	`inherit_transform`	`VISUAL_HINT_DEFAULT`	Does the current object inherits its parent transformation ?
`long`	`reference_frame`	`VISUAL_HINT_FRAME`	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.
`object[]` (`Constraint`)	`constraints`	`VISUAL_HINT_DEFAULT`	Stack of constraint operators. Constraints like Target, Point, Orient... are applied to a Scene Item in order to drive the transformation of the item.
`double[3]`	`scale_pivot`	`VISUAL_HINT_DISTANCE`	Set the coordinates of the scale pivot.
`double[3]`	`rotate_pivot`	`VISUAL_HINT_DISTANCE`	Set the coordinates of the rotation pivot.
`double[3]`	`translate_offset`	`VISUAL_HINT_DISTANCE`	Set the XYZ position of the pivot point of the item.
`double[3]`	`rotate_offset`	`VISUAL_HINT_ANGLE`	Set the XYZ rotation of the pivot point of the item.
`double[3]`	`scale_offset`	`VISUAL_HINT_SCALE`	Set the XYZ scaling of the pivot point of the item.
`long`	`rotation_offset_order`	`VISUAL_HINT_DEFAULT`	Set the rotation axis mode.
`bool`	`display_visible`	`VISUAL_HINT_DEFAULT`	Set whether the item is shown in the 3D View or not.
`bool`	`display_pickable`	`VISUAL_HINT_DEFAULT`	Set whether the item is pickable in the 3D View or in the Image View.
`long`	`display_color`	`VISUAL_HINT_DEFAULT`	Set the item color for constant or simple shading display in the 3D View.
`double[3]`	`display_custom_color`	`VISUAL_HINT_COLOR`	Set the item custom color used for display in the 3D View when the Display Color attribute is set to Custom.
`long`	`visibility_mode`	`VISUAL_HINT_DEFAULT`	Set how visibility attributes 'Display Visible' and 'Unseen By Renderer' are driven. In Use Project Preferences mode, the mode uses the project preference value. In Override mode, the attributes are set manually. In Use Property mode, the attributes are driven by a property (e.g. Alembic visibility property).
`bool`	`enable_motion_blur`	`VISUAL_HINT_DEFAULT`	Set whether the renderer will do motion blur on the item or not.
`long`	`display_mode`	`VISUAL_HINT_DEFAULT`	Define how the object is displayed in the 3D View.
`long`	`highlight_mode`	`VISUAL_HINT_DEFAULT`	Define how the object is highlighted in the 3D View when selected.
`reference` (`Material`)	`override_material`	`VISUAL_HINT_DEFAULT`	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.
`bool`	`matte_object`	`VISUAL_HINT_DEFAULT`	Switch the object to 2D matte mode.
`double[3]`	`matte_color`	`VISUAL_HINT_COLOR`	Set the color of the object in matte mode.
`double`	`matte_alpha`	`VISUAL_HINT_PERCENTAGE`	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.
`long`	`custom_id`	`VISUAL_HINT_DEFAULT`
`double`	`raytrace_offset`	`VISUAL_HINT_DISTANCE`	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.
`string`	`shading_variables`	`VISUAL_HINT_SCRIPT`
`bool`	`unseen_by_renderer`	`VISUAL_HINT_DEFAULT`	Set whether the object is hidden from the renderer or not.
`bool`	`unseen_by_camera`	`VISUAL_HINT_DEFAULT`	Set whether the object is hidden from the camera (primary rays) or not.
`bool`	`unseen_by_rays`	`VISUAL_HINT_DEFAULT`	Set whether the object is hidden from the raytraced shading effects like reflection/refraction (secondary rays) or not.
`bool`	`unseen_by_reflections`	`VISUAL_HINT_DEFAULT`	Set whether the object is hidden from reflections or not.
`bool`	`unseen_by_refractions`	`VISUAL_HINT_DEFAULT`	Set whether the object is hidden from refractions or not.
`bool`	`unseen_by_gi`	`VISUAL_HINT_DEFAULT`	Set whether the object is hidden from global illumination or not.
`bool`	`unseen_by_sss`	`VISUAL_HINT_DEFAULT`	Set whether the object is hidden from sub-surface scattering or not.
`bool`	`cast_shadows`	`VISUAL_HINT_DEFAULT`	Set whether the object casts shadows or not.
`bool`	`receive_shadows`	`VISUAL_HINT_DEFAULT`	Set whether the object receives cast shadows or not.
`bool`	`receive_self_shadows`	`VISUAL_HINT_DEFAULT`	Set whether the object receives self shadows or not.
`reference` (`Group`)	`lights`	`VISUAL_HINT_GROUP`	Specify the group of lights that illuminate this object. By default, scene objects are lit using the lights gathered by the 3D layer.
`bool`	`enable_emission_importance_sampling`	`VISUAL_HINT_DEFAULT`	Specify whether emission importance sampling is enabled on the scene object. This attribute is ignored when emission importance sampling is disabled in the renderer.
`long`	`emission_sample_count`	`VISUAL_HINT_SAMPLE_PER_PIXEL`	Override the number of emission samples allocated by the renderer when sampling the scene object.
`long`	`emission_texture_importance_sampling`	`VISUAL_HINT_DEFAULT`	When None, no texture importance sampling is performed. When Color, Emission Color input textures of all materials assigned to the scene object are importance sampled. This mode should be used when only the Emission Color of the material is textured which is typically the case when using an HDR texture encoding both color and intensity. When Weight, Emission Weight input textures of all the materials assigned to the scene object are importance sampled. This mode can be useful when you explicitly want to vary the color texture according to a spatial projection based on the position of the instance such as world projections, texture switch or instance color for example. Please note that setting this mode while texturing Emission Color can lead to a degradation of the quality of the importance sampling if the intensity/weight component is encoded to the color textures. When Both, both Emission Color and Emission Weight input textures of all the materials assigned to the scene object are importance sampled. This mode should be used when using specific textures for Emission Color and Emission Weight.
`object[]` (`Deformer`)	`deformers`	`VISUAL_HINT_DEFAULT`	List of deformation that will be applied on the geometry.
`double`	`smoothing_approximation`	`VISUAL_HINT_PERCENTAGE`	Controls how much the smoothing must be approximated during the shading. This influences the origin of secondary rays casted from the surface. A value of 0% corresponds to the position that has been found during the raytracing and a value of 100% corresponds to the theoretical position on the smoothed surface.
`long`	`displacement_mode`	`VISUAL_HINT_DEFAULT`	Control whether the displacement must compute bump, tessellation or both.
`long`	`displacement_storage_mode`	`VISUAL_HINT_DEFAULT`	Define if displacement favors render time or memory used to generate it.
`long`	`displacement_tessellation_mode`	`VISUAL_HINT_DEFAULT`	Control the generation of the tessellation used for the micro displacement. Adaptive modes try to compute the tessellation level according to the size of the primitives whereas the uniform mode generates the same tessellation on all primitives. For the adaptive modes, it is possible to choose if the tessellation level has to be computed on the base geometry or on the deformed one.
`long`	`displacement_adaptive_span_count`	`VISUAL_HINT_DEFAULT`	Control the number of spans for the adaptive tessellation. This value corresponds to the number of spans on the bounding box of the geometry.
`long`	`displacement_uniform_span_count`	`VISUAL_HINT_DEFAULT`	Control the number of spans for the uniform tessellation. This value corresponds to the number of spans on each primitive.
`long`	`displacement_triangulation_mode`	`VISUAL_HINT_DEFAULT`	Define on which geometry the micro-facets triangulation is computed.
`long`	`displacement_stitching_mode`	`VISUAL_HINT_DEFAULT`	Control the stitching between primitives. The stitching only affects values of the displacement so it doesn't work if the geometry has discontinuities on normals.

CID#

class "GeometryUsdCube" "Geometry" {
    abstract yes
    #version 1
    icon "./icons/geometry_cube_usd.iconrc"
    doc "USD cube reference."
    bool "purpose_selected" {
        output "geometry"
        private yes
        saveable no
        value yes
    }
    string "session_layer" {
        private yes
        value ""
    }
    long "geometry_hash" {
        private yes
        saveable no
        value 0
    }
    attribute_group "USD" {
        list<filename_open> "filename" {
            doc "The filename that were used to create the stage from which this object is referenced."
            private yes
            dg_active no
            read_only yes
            value <empty>
        }
        string "prim_path" {
            doc "Prim path in the USD stage."
            dg_active no
            read_only yes
            value ""
        }
        string "purpose" {
            doc "Purpose of this prim."
            saveable no
            dg_active no
            read_only yes
            value "default"
        }
        long "stage_id" {
            private yes
            saveable no
            dg_active no
            read_only yes
            value -1
        }
    }
    attribute_group "USD>playback" {
        collapsed yes
        frame "frame" {
            doc "Define the frame value used to evaluate the geometry."
            animatable yes
            value[] 0
            expression "F"
        }
        frame "frame_offset" {
            doc "Define the frame offset. Example: if the frame offset is 50 while the animation starts at frame 10, then it will start at frame 60."
            animatable yes
            value 0
        }
        long "animation_behavior" {
            doc "Define the animation loop behavior."
            preset "Hold" "0"
            preset "Repeat" "1"
            value 0
        }
        bool "force_animation_range" {
            doc "Enable the defined animation range, used to override the object\'s original animation range."
            value no
        }
        frame[2] "animation_range" {
            doc "Start and end frames for the animation."
            read_only yes
            value 0 50
        }
        double "time_offset" {
            private yes
            saveable no
            read_only yes
            value 0.0
        }
    }
    attribute_group "USD>variant_sets" {
        collapsed yes
    }
}