ToolRotateItem

ToolRotateItem#

(Rotate Item)

Category: Transform
Default object name: rotate_item
Inherits from: Tool

Description#

Edit the rotation of scene items.

Public Attributes#

Type	Name	Visual Hint	Description
`double`	`opacity_threshold`	`VISUAL_HINT_PERCENTAGE`	Set the threshold value under which the object is considered transparent therefore not selectable.
`long`	`space`	`VISUAL_HINT_DEFAULT`	Set the space to use to rotate the object. In Manipulator space, object's translation may be affected.
`long`	`mode`	`VISUAL_HINT_DEFAULT`	Set the mode of the tool.
`bool`	`skip_children`	`VISUAL_HINT_DEFAULT`	In case a child and its parent are transformed altogether, do not apply transformation to child. Otherwise, child is transformed twice.
`double[3]`	`manipulator_interest_center`	`VISUAL_HINT_DISTANCE`	Set the position of the rotate manipulator in world coordinates. Used in Manipulator mode.
`double[3]`	`manipulator_display_offset`	`VISUAL_HINT_DISTANCE`	Set the XYZ offset of the pivot manipulator relative to selected item's actual pivot.
`bool`	`snap_enabled`	`VISUAL_HINT_DEFAULT`	Enable or disable snap mode
`double`	`snap_increment`	`VISUAL_HINT_ANGLE`	Set the snap increment of the tool.
`double`	`pivot_snap_increment`	`VISUAL_HINT_DISTANCE`	Set the snap increment of the tool in Pivot mode.
`long`	`pivot_snap_default_plane`	`VISUAL_HINT_DEFAULT`	Snap plane when no surface is hit. Used in Pivot mode.
`long`	`pivot_snap_distance`	`VISUAL_HINT_PIXEL`	Distance in screen space for vertex snapping. Used in Pivot mode.
`long`	`single_selection`	`VISUAL_HINT_DEFAULT`	Define how the manipulator is relocated when selection changes.
`long`	`multi_selection`	`VISUAL_HINT_DEFAULT`	Define how the manipulator is relocated when selection changes.

CID#

class "ToolRotateItem" "Tool" {
    #version 0.9
    icon "../icons/object_icons/tool_rotate.iconrc"
    category "Transform"
    doc "Edit the rotation of scene items."
    ui_weight 70
    reference "constraint" {
        filter "Constraint"
        hidden yes
        value ""
    }
    attribute_group "picking" {
        percentage "opacity_threshold" {
            doc "Set the threshold value under which the object is considered transparent therefore not selectable."
            slider yes
            ui_range yes 0.0 1
            value 0.5
        }
    }
    attribute_group "rotate_tool" {
        long "space" {
            doc "Set the space to use to rotate the object. In Manipulator space, object\'s translation may be affected."
            preset "Object (default)" "0"
            preset "World" "1"
            preset "Gimbal" "2"
            preset "Manipulator" "3"
            value 0
        }
        long "mode" {
            doc "Set the mode of the tool."
            preset "Rotate" "0"
            preset "Offset" "1"
            preset "Pivot" "2"
            value 0
        }
        bool "skip_children" {
            doc "In case a child and its parent are transformed altogether, do not apply transformation to child. Otherwise, child is transformed twice."
            value no
        }
        distance[3] "manipulator_interest_center" {
            doc "Set the position of the rotate manipulator in world coordinates. Used in Manipulator mode."
            read_only yes
            value 0.0 0.0 0.0
        }
        distance[3] "manipulator_display_offset" {
            doc "Set the XYZ offset of the pivot manipulator relative to selected item\'s actual pivot."
            read_only yes
            value 0.0 0.0 0.0
        }
    }
    attribute_group "increment_snapping" {
        bool "snap_enabled" {
            doc "Enable or disable snap mode"
            value no
        }
        angle "snap_increment" {
            doc "Set the snap increment of the tool."
            value 15
        }
        distance "pivot_snap_increment" {
            doc "Set the snap increment of the tool in Pivot mode."
            read_only yes
            value 1
        }
        long "pivot_snap_default_plane" {
            doc "Snap plane when no surface is hit. Used in Pivot mode."
            read_only yes
            preset "YZ" "0"
            preset "XZ" "1"
            preset "YX" "2"
            value 1
        }
        pixel "pivot_snap_distance" {
            doc "Distance in screen space for vertex snapping. Used in Pivot mode."
            read_only yes
            value 10
        }
    }
    attribute_group "manipulator_initialization" {
        collapsed yes
        long "single_selection" {
            doc "Define how the manipulator is relocated when selection changes."
            preset "Unchanged" "0"
            preset "World Origin" "1"
            preset "Object Pivot" "2"
            preset "Object Bounding Box Center" "3"
            preset "Object Bounding Box Ground" "4"
            value 2
        }
        long "multi_selection" {
            doc "Define how the manipulator is relocated when selection changes."
            preset "Unchanged" "0"
            preset "World Origin" "1"
            preset "Last Selected Pivot" "2"
            preset "Selection Bounding Box Center" "3"
            preset "Selection Bounding Box Ground" "4"
            value 3
        }
    }
}