Skip to content

ToolTranslateItem

ToolTranslateItem#

(Translate Item)

  • Category: Transform
  • Default object name: translate_item
  • Inherits from: Tool

Go to User page.

Description#

Edit the position 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 move the object.
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_display_offset VISUAL_HINT_DISTANCE Set the XYZ offset of the manipulator relative to selected item's actual pivot.
bool align_to_normal VISUAL_HINT_DEFAULT Rotate item to align with surface normal.
bool snap_individually VISUAL_HINT_DEFAULT When not in manipulator space and snapping several items altogether, items either snap individually around the manipulator snapped position or they all snap to the same hit location.
long snap_default_plane VISUAL_HINT_DEFAULT Snap plane when no surface is hit.
long snap_distance VISUAL_HINT_PIXEL Distance in screen space for vertex snapping.
bool snap_manipulator_only VISUAL_HINT_DEFAULT Disconnect manipulator from items when snapping: snapping will modify the manipulator display offset rather than the items.
bool snap_enabled VISUAL_HINT_DEFAULT Enable or disable snap mode
double snap_increment VISUAL_HINT_DISTANCE Set the snap increment of the tool.
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 "ToolTranslateItem" "Tool" {
    #version 0.9
    icon "../icons/object_icons/tool_translate.iconrc"
    category "Transform"
    doc "Edit the position of scene items."
    ui_weight 80
    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 "translate_tool" {
        long "space" {
            doc "Set the space to use to move the object."
            preset "Object" "0"
            preset "Parent (default)" "1"
            preset "World" "2"
            preset "Manipulator" "3"
            value 1
        }
        long "mode" {
            doc "Set the mode of the tool."
            preset "Translate" "0"
            preset "Offset" "1"
            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_display_offset" {
            doc "Set the XYZ offset of the manipulator relative to selected item\'s actual pivot."
            value 0.0 0.0 0.0
        }
    }
    attribute_group "surface_snapping" {
        bool "align_to_normal" {
            doc "Rotate item to align with surface normal."
            value no
        }
        bool "snap_individually" {
            doc "When not in manipulator space and snapping several items altogether, items either snap individually around the manipulator snapped position or they all snap to the same hit location."
            value yes
        }
        long "snap_default_plane" {
            doc "Snap plane when no surface is hit."
            preset "YZ" "0"
            preset "XZ" "1"
            preset "YX" "2"
            value 1
        }
        pixel "snap_distance" {
            doc "Distance in screen space for vertex snapping."
            value 10
        }
        bool "snap_manipulator_only" {
            doc "Disconnect manipulator from items when snapping: snapping will modify the manipulator display offset rather than the items."
            value no
        }
    }
    attribute_group "increment_snapping" {
        bool "snap_enabled" {
            doc "Enable or disable snap mode"
            value no
        }
        distance "snap_increment" {
            doc "Set the snap increment of the tool."
            value 1
        }
    }
    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
        }
    }
}