SceneItem

SceneItem#

(Scene Item)

Abstract Class
Default object name: scene_item
Inherits from: ProjectItem
Inherited by: Camera, Light, Locator, Portal, SceneObject, Scope

No corresponding User page.

Description#

General description of objects that have a transformation (translation/rotation/scaling) in space. Ex: lights, cameras, locators, geometries.

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.
`bool`	`enable_motion_blur`	`VISUAL_HINT_DEFAULT`	Set whether the renderer will do motion blur on the item or not.

CID#

class "SceneItem" "ProjectItem" {
    abstract yes
    #version 0.91
    icon "../icons/object_icons/xform.iconrc"
    doc "General description of objects that have a transformation (translation/rotation/scaling) in space. Ex: lights, cameras, locators, geometries."
    attribute_group "kinematics" {
        collapsed yes
        distance[3] "translate" {
            doc "Set the XYZ position of the item relative to its parent item."
            input "motion_translate"
            output "motion_translate"
            animatable yes
            value 0.0 0.0 0.0
        }
        angle[3] "rotate" {
            doc "Set the XYZ rotation of the item relative to its parent item."
            input "motion_rotate"
            output "motion_rotate"
            animatable yes
            value 0.0 0.0 0.0
        }
        scale[3] "scale" {
            doc "Set the XYZ scaling of the item relative to its parent item."
            input "motion_scale"
            output "motion_scale"
            animatable yes
            value 1 1 1
        }
        scale[3] "shear" {
            doc "Set the XYZ shear of the item relative to its parent item."
            input "motion_scale"
            output "motion_scale"
            animatable yes
            value 0.0 0.0 0.0
        }
        long "rotation_order" {
            doc "Specify on which order the Euler rotations are composed. By default Clarisse\'s uses YXZ"
            output "motion_rotate"
            preset "XYZ" "8193"
            preset "XZY" "4353"
            preset "YZX" "1"
            preset "YXZ" "8449"
            preset "ZXY" "4097"
            preset "ZYX" "257"
            value 4097
        }
        reference "parent" {
            doc "Set the parent item of the item."
            filter "SceneItem"
            input "motion" "parenting" "motion_blur"
            dirtiness_pass_through yes
            value ""
        }
    }
    attribute_group "kinematics>advanced" {
        collapsed yes
        ui_weight 1000
        bool "inherit_transform" {
            doc "Does the current object inherits its parent transformation ?"
            output "motion"
            value yes
        }
        frame "reference_frame" {
            doc "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."
            output "geometry_base"
            value 0
        }
        object[] "constraints" {
            doc "Stack of constraint operators. Constraints like Target, Point, Orient... are applied to a Scene Item in order to drive the transformation of the item."
            filter "Constraint"
            input "motion"
            output "motion"
            value <empty>
        }
    }
    attribute_group "kinematics>pivot/offset" {
        collapsed yes
        distance[3] "scale_pivot" {
            doc "Set the coordinates of the scale pivot."
            output "motion"
            value 0.0 0.0 0.0
        }
        distance[3] "rotate_pivot" {
            doc "Set the coordinates of the rotation pivot."
            output "motion"
            value 0.0 0.0 0.0
        }
        distance[3] "scale_pivot_offset" {
            output "motion"
            private yes
            dg_active no
            value 0.0 0.0 0.0
        }
        distance[3] "rotate_pivot_offset" {
            output "motion"
            private yes
            dg_active no
            value 0.0 0.0 0.0
        }
        distance[3] "translate_offset" {
            doc "Set the XYZ position of the pivot point of the item."
            output "motion_translate"
            animatable yes
            value 0.0 0.0 0.0
        }
        angle[3] "rotate_offset" {
            doc "Set the XYZ rotation of the pivot point of the item."
            output "motion_rotate"
            animatable yes
            value 0.0 0.0 0.0
        }
        scale[3] "scale_offset" {
            doc "Set the XYZ scaling of the pivot point of the item."
            output "motion_scale"
            animatable yes
            value 1 1 1
        }
        long "rotation_offset_order" {
            doc "Set the rotation axis mode."
            output "motion_rotate"
            preset "Invert Rotation Order" "0"
            preset "XYZ" "8193"
            preset "XZY" "4353"
            preset "YZX" "1"
            preset "YXZ" "8449"
            preset "ZXY" "4097"
            preset "ZYX" "257"
            value 4097
        }
    }
    attribute_group "display" {
        collapsed yes
        bool "display_visible" {
            doc "Set whether the item is shown in the 3D View or not."
            output "gl"
            animatable yes
            value yes
        }
        bool "display_pickable" {
            doc "Set whether the item is pickable in the 3D View or in the Image View."
            output "gl"
            animatable yes
            value yes
        }
        long "display_color" {
            doc "Set the item color for constant or simple shading display in the 3D View."
            output "gl"
            preset "Black" "0"
            preset "Dark Red" "1"
            preset "Red" "2"
            preset "Pink" "3"
            preset "Violet" "4"
            preset "Dark Cyan" "5"
            preset "Cyan" "6"
            preset "Dark Green" "7"
            preset "Green" "8"
            preset "Dark Blue" "9"
            preset "Blue" "10"
            preset "Dark Gray" "11"
            preset "Gray" "12"
            preset "Dark Yellow" "13"
            preset "Yellow" "14"
            preset "White" "15"
            preset "Custom" "16"
            value 12
        }
        color "display_custom_color" {
            doc "Set the item custom color used for display in the 3D View when the Display Color attribute is set to Custom."
            output "gl"
            read_only yes
            value 0.78 0.78 0.78
        }
        long "display_motion_trail" {
            doc "Specify when to display item motion trail in the 3D View, provided the item is animated."
            hidden yes
            preset "Off" "0"
            preset "Selected" "1"
            preset "Always" "2"
            value 0
        }
        long "motion_trail_samples" {
            doc "Specify when to display direction markers along item motion trail in the 3D View, provided the item is animated. By default, a marker is drawn on each key."
            null_label "keys"
            null_value "0"
            hidden yes
            numeric_range yes 0.0 1000000
            ui_range yes 0.0 100
            value 0
        }
        bool "motion_trail_action_tube" {
            doc "Display/hide action tube, based on temporal sequence of bounding boxes."
            hidden yes
            dg_active no
            value no
        }
        distance "aim_distance" {
            hidden yes
            dg_active no
            value 5
        }
    }
    attribute_group "rendering>visibility" {
        long "visibility_mode" {
            doc "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)."
            hidden yes
            preset "Use Project Preferences" "2"
            preset "Override" "0"
            preset "Use Property" "1"
            value 2
        }
        long "__visibility_mode__" {
            private yes
            saveable no
            value 0
        }
    }
    attribute_group "motion_blur" {
        collapsed yes
        bool "enable_motion_blur" {
            doc "Set whether the renderer will do motion blur on the item or not."
            output "shading" "motion_blur"
            animatable yes
            value yes
        }
        long "require_motion_blur" {
            output "shading" "motion_blur"
            private yes
            saveable no
            value 0
        }
    }
}