Scope

Scope#

(Scope)

Default object name: scope
Inherits from: ProjectItem > SceneItem

Description#

Defines a 3D scope with an inside region transitioning to an outside region, that can be used typically to express 3D gradients.

Public Attributes#

Type	Name	Visual Hint	Description
`long`	`shape`	`VISUAL_HINT_DEFAULT`	Shape of the scope.
`double`	`falloff`	`VISUAL_HINT_PERCENTAGE`	Size of the falloff region, delimitating the inside and outside of the scope.
`double`	`falloff_exponent`	`VISUAL_HINT_DEFAULT`	Profile of the the falloff region, defining how steep the transition is between the inside and outside regions.
`bool`	`inside_out`	`VISUAL_HINT_DEFAULT`	Invert inside and outside regions.

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

CID#

class "Scope" "SceneItem" {
    #version 1
    doc "Defines a 3D scope with an inside region transitioning to an outside region, that can be used typically to express 3D gradients."
    attribute_group "shape" {
        long "shape" {
            doc "Shape of the scope."
            preset "Box" "0"
            preset "Sphere" "1"
            preset "Cylinder" "2"
            value 0
        }
        percentage "falloff" {
            doc "Size of the falloff region, delimitating the inside and outside of the scope."
            slider yes
            numeric_range yes 0.0 1
            ui_range yes 0.0 1
            value 0.1
        }
        double "falloff_exponent" {
            doc "Profile of the the falloff region, defining how steep the transition is between the inside and outside regions."
            slider yes
            numeric_range yes 0.0 10
            ui_range yes 0.0 5
            value 1
        }
        bool "inside_out" {
            doc "Invert inside and outside regions."
            value no
        }
    }
}