Skip to content

ToolRuler

ToolRuler#

(Ruler)

  • Category: Measure
  • Default object name: ruler
  • Inherits from: Tool

Go to User page.

Description#

Measure distance in world units between two points of the scene.

Public Attributes#

Type Name Visual Hint Description
long log_information VISUAL_HINT_DEFAULT Indicate when to print out the requested information: first mode will only do it when the mouse button is released, second mode at each new cursor position as long as the mouse button is down.
long copy_to_clipboard VISUAL_HINT_DEFAULT Enable/Disable copy of the requested information to clipboard on mouse up.
bool world_position VISUAL_HINT_DEFAULT Enable/Disable the output of the ruler's end positions.
bool eye_distance VISUAL_HINT_DEFAULT Enable/Disable the output of the ruler's distances to camera.
long precision VISUAL_HINT_DEFAULT Set the number of digits for decimal part of numbers.

CID#

class "ToolRuler" "Tool" {
    #version 1
    icon "../icons/object_icons/tool_ruler.iconrc"
    category "Measure"
    doc "Measure distance in world units between two points of the scene."
    attribute_group "ruler_tool" {
        long "log_information" {
            doc "Indicate when to print out the requested information: first mode will only do it when the mouse button is released, second mode at each new cursor position as long as the mouse button is down."
            preset "On Mouse Release" "0"
            preset "On Mouse Move" "1"
            value 0
        }
        long "copy_to_clipboard" {
            doc "Enable/Disable copy of the requested information to clipboard on mouse up."
            preset "None" "0"
            preset "Distance" "1"
            preset "World Position" "2"
            preset "Eye Distance" "3"
            value 0
        }
        bool "world_position" {
            doc "Enable/Disable the output of the ruler\'s end positions."
            value no
        }
        bool "eye_distance" {
            doc "Enable/Disable the output of the ruler\'s distances to camera."
            value no
        }
        long "precision" {
            doc "Set the number of digits for decimal part of numbers."
            numeric_range yes 0.0 10
            value 2
        }
    }
}