IDLitManipulator Properties

IDLitManipulator objects have the following properties in addition to properties inherited from any superclasses. Properties with the word "Yes" in the "Get" column of the property table can be retrieved via IDLitManipulator::GetProperty. Properties with the word "Yes" in the "Init" column of the property table can be set via IDLitManipulator::Init. Properties with the word "Yes" in the "Set" column in the property table can be set via IDLitManipulator::SetProperty.

Note
For a discussion of the property description tables shown below, see About Object Property Descriptions.

Objects of this class have the following properties.

In addition, objects of this class inherit:

BUTTON_EVENTS

A boolean value controlling whether mouse button events are generated. If set, mouse button up and button down events will be dispatched to this manipulator. These events are enabled by default.

DEFAULT_CURSOR

A string containing the name of the default cursor for the manipulator. This is the name of the cursor that is displayed if no items are hit during mouse cursor motion. The default manipulator cursor is set to 'ARROW'. Allowable values are:

Note
Set a pre-defined default cursor using the Init or SetProperty method. Set a custom cursor as the default cursor using the IDLitManipulator::RegisterCursor method's DEFAULT keyword.

DESCRIPTION

A string representing the full name or description of this object.

DISABLE

A boolean value indicating that the manipulator should be disabled. Disabling a manipulator prevents it from being chosen by a user or by the iTool system. The default value is 0b (false).

KEYBOARD_EVENTS

A boolean value controlling whether keyboard events are generated. If set, keyboard events will be dispatched to the manipulator. These events are enabled by default.

MOTION_EVENTS

A boolean value controlling whether motion events are generated. If set, motion events will be dispatched to this manipulator. These events are enabled by default.

OPERATION_IDENTIFIER

A string identifier for the operation that is associated with the manipulator. This identifier specifies the operation that is used by the undo-redo system to transact the actions performed by this manipulator. If not specified, the manipulator actions are not recorded by the undo-redo system.

Note
See Manipulators and the Undo/Redo System (iTool Developer's Guide) for information on configuring a custom manipulator to support undo/redo operations.

PARAMETER_IDENTIFIER

A string identifier specifying which parameter the operation should query when transacting the manipulator. If specified, this identifier is used in conjunction with the operation specified by the OPERATION_IDENTIFIER property to transact the operations performed by a manipulator. The parameter is primarily used to specify the property identifier for manipulators that change the values of properties.

Note
See Retrieving Property Information (iTool Developer's Guide) for more information about property identifiers and names. See Manipulators and the Undo/Redo System (iTool Developer's Guide) for information on configuring a custom manipulator to support undo/redo operations.

TRANSIENT_DEFAULT

An integer value used to indicate that the manipulator is transient, which causes the system to automatically switch to the default manipulator when this manipulator's mouse actions are complete (that is, when the OnMouseUp method has been called) or when an end-of-keyboard-entry character (carriage return or escape key) is detected. The default value is 0.

This property can be set to any of the following values:

TRANSIENT_MOTION

A boolean value controlling whether transient motion events are generated. If set, the manipulator will generate motion events beginning when the OnMouseDown method is called and ending when the OnMouseUp method is called. The default value is 0b (false).

TYPES

A string array specifying the visualization types that this manipulator can operate on. If not specified, the manipulator will support all registered visualization types. Allowable TYPES values are those returned by the IDLitVisualization::GetTypes method.

VIEWS_ONLY

A boolean value controlling the content of the manipulator hierarchy. If set, the manipulator will only operate on views in the manipulator hierarchy. The default value is 0b (false).

VISUAL_TYPE

A string representing the type of selection visual to use with this manipulator. The VISUAL_TYPE property should match the corresponding property of an IDLitManipulatorVisual object. This high-level abstraction allows similar selection visuals to be assigned across multiple manipulators. The default value is an empty string.