View source for Vmodel (lx-vmodel.hpp)

{{DISPLAYTITLE:vmodel (lx_vmodel.hpp)}}

<span id="S1"></span>
== 3D Viewport SDK ==

<span id="C1"></span>
<span id="S1.1"></span>
=== ViewItem3D Interface ===

A 3D view item plug-in defines the appearance of an entity in abstract 3D space.

===== (1) SDK: LXu_VIEWITEM3D, etc. defines =====

<syntaxhighlight>
 #define [[LXu_VIEWITEM3D (index)|LXu_VIEWITEM3D]]          "5E0E5E09-9D9F-447C-AEDA-2F6F266DB464"
 #define [[LXa_VIEWITEM3D (index)|LXa_VIEWITEM3D]]          "viewitem3dv2"</syntaxhighlight>

<span id="C2"></span>
===== (2) SDK: LXiSELECTION_UNSELECTED, etc. defines =====

<syntaxhighlight>
 #define [[LXiSELECTION_UNSELECTED (index)|LXiSELECTION_UNSELECTED]]         0
 #define [[LXiSELECTION_SELECTED (index)|LXiSELECTION_SELECTED]]           1
 #define [[LXiSELECTION_ROLLOVER (index)|LXiSELECTION_ROLLOVER]]           2
 
 #define [[LXiMOTION_1D (index)|LXiMOTION_1D]]                    1 // obsolete
 #define [[LXiMOTION_ANGULAR (index)|LXiMOTION_ANGULAR]]               2 // obsolete
 #define [[LXiMOTION_RADIAL (index)|LXiMOTION_RADIAL]]                3 // obsolete
 
 #define [[LXiVHANDLE_BASE_PART (index)|LXiVHANDLE_BASE_PART]]            400
 
 #define [[LXmVHANDLE_CONSTRAINT (index)|LXmVHANDLE_CONSTRAINT]]           7 // mask off bottom 3 bits for 8 constraint types
 #define [[LXfVHANDLE_CON_LINEAR (index)|LXfVHANDLE_CON_LINEAR]]           1
 #define [[LXfVHANDLE_CON_PLANAR (index)|LXfVHANDLE_CON_PLANAR]]           2
 
 #define [[LXmVHANDLE_DRAW_SHAPE (index)|LXmVHANDLE_DRAW_SHAPE]]           (15<<3) // mask off next 4 bits for 16 draw shapes
 #define [[LXfVHANDLE_DRAW_BOX (index)|LXfVHANDLE_DRAW_BOX]]             (0)
 #define [[LXfVHANDLE_DRAW_LINE (index)|LXfVHANDLE_DRAW_LINE]]            (1<<3)
 #define [[LXfVHANDLE_DRAW_POINT (index)|LXfVHANDLE_DRAW_POINT]]           (2<<3)
 #define [[LXfVHANDLE_DRAW_PLUS (index)|LXfVHANDLE_DRAW_PLUS]]            (3<<3)
 #define [[LXfVHANDLE_DRAW_X (index)|LXfVHANDLE_DRAW_X]]               (4<<3)
 #define [[LXxVHANDLE_DRAW_SHAPE (index)|LXxVHANDLE_DRAW_SHAPE]](f)        ((f)&[[LXmVHANDLE_DRAW_SHAPE (index)|LXmVHANDLE_DRAW_SHAPE]])
 
 #define [[LXmVHANDLE_DRAW_AXIS (index)|LXmVHANDLE_DRAW_AXIS]]            (3<<16) // mask off bottom 2 bits of next word for 4 axis values
 #define [[LXxVHANDLE_DRAW_AXIS (index)|LXxVHANDLE_DRAW_AXIS]](f)         (((f)>>16)&3)
 
 #define [[LXfVHANDLE_VAL_VECTOR (index)|LXfVHANDLE_VAL_VECTOR]]           (1<<8)
 #define [[LXfVHANDLE_VAL_2D (index)|LXfVHANDLE_VAL_2D]]               (2<<8)
 #define [[LXfVHANDLE_RESERVED (index)|LXfVHANDLE_RESERVED]]             (1<<31) // PRIVATE! HANDS OFF
 
</syntaxhighlight>

<span id="C3"></span>
===== (3) SDK: ViewItem3D::Draw, etc. =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]](  [[LxResult (index)|LxResult]],
 Draw) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              chanRead,
         [[LXtObjectID (index)|LXtObjectID]]              strokeDraw,
         int                      selectionFlags,
         const [[LXtVector (index)|LXtVector]]          itemColor);
 
         [[LXxMETHOD (index)|LXxMETHOD]](  [[LxResult (index)|LxResult]],
 DrawBackground) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              chanRead,
         [[LXtObjectID (index)|LXtObjectID]]              strokeDraw,
         const [[LXtVector (index)|LXtVector]]          itemColor);
 
         [[LXxMETHOD (index)|LXxMETHOD]](  [[LxResult (index)|LxResult]],
 WorldSpace) (
         [[LXtObjectID (index)|LXtObjectID]]              self);
 
         [[LXxMETHOD (index)|LXxMETHOD]](  [[LxResult (index)|LxResult]],
 HandleCount) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         int                     *count);
 
         [[LXxMETHOD (index)|LXxMETHOD]](  [[LxResult (index)|LxResult]],
 HandleMotion) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         int                      handleIndex,
         int                     *handleFlags,
         double                  *min,
         double                  *max,
         [[LXtVector (index)|LXtVector]]                plane,
         [[LXtVector (index)|LXtVector]]                offset);
 
         [[LXxMETHOD (index)|LXxMETHOD]](  [[LxResult (index)|LxResult]],
 HandleChannel) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         int                      handleIndex,
         int                     *chanIndex);
 
         [[LXxMETHOD (index)|LXxMETHOD]](  [[LxResult (index)|LxResult]],
 HandleValueToPosition) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         int                      handleIndex,
         const double            *chanValue,
         [[LXtVector (index)|LXtVector]]                position);
 
         [[LXxMETHOD (index)|LXxMETHOD]](  [[LxResult (index)|LxResult]],
 HandlePositionToValue) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         int                      handleIndex,
         const [[LXtVector (index)|LXtVector]]          position,
         double                  *chanValue);
</syntaxhighlight>

<span id="C4"></span>
"Test" is called to hit test the item.  If "Test" is not implemented, "Draw" method is called for hit testing.

===== (4) SDK: ViewItem3D::Test =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]](  [[LxResult (index)|LxResult]],
 Test) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              chanRead,
         [[LXtObjectID (index)|LXtObjectID]]              strokeDraw,
         int                      selectionFlags,
         const [[LXtVector (index)|LXtVector]]          itemColor);
</syntaxhighlight>

<span id="C5"></span>
Empty ViewItem3D Python user class.

===== (5) PY: empty ViewItem3D user class =====

<syntaxhighlight>
 pass
</syntaxhighlight>

<span id="C6"></span>
<span id="S1.2"></span>
=== ILxViewItem3D1 (Legacy Interface) ===

This interface was retired in modo 701, and was replaced with an updated one that adds a few more methods.

===== (6) SDK: LXu_VIEWITEM3D1, etc. defines =====

<syntaxhighlight>
 #define [[LXu_VIEWITEM3D1 (index)|LXu_VIEWITEM3D1]]         "9BCE73B5-3264-48BB-B129-15FF53FD1661"
 #define [[LXa_VIEWITEM3D1 (index)|LXa_VIEWITEM3D1]]         "viewitem3d"</syntaxhighlight>

<span id="C7"></span>
===== (7) SDK: ViewItem3D1::Draw, etc. =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]](  [[LxResult (index)|LxResult]],
 Draw) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              chanRead,
         [[LXtObjectID (index)|LXtObjectID]]              strokeDraw,
         int                      selectionFlags,
         [[LXtVector (index)|LXtVector]]                itemColor);
 
         [[LXxMETHOD (index)|LXxMETHOD]](  [[LxResult (index)|LxResult]],
 DrawBackground) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              chanRead,
         [[LXtObjectID (index)|LXtObjectID]]              strokeDraw,
         [[LXtVector (index)|LXtVector]]                itemColor);
 
         [[LXxMETHOD (index)|LXxMETHOD]](  [[LxResult (index)|LxResult]],
 WorldSpace) (
         [[LXtObjectID (index)|LXtObjectID]]              self);
 
         [[LXxMETHOD (index)|LXxMETHOD]](  [[LxResult (index)|LxResult]],
 HandleCount) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         int                     *count);
 
         [[LXxMETHOD (index)|LXxMETHOD]](  [[LxResult (index)|LxResult]],
 HandleMotion) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         int                      handleIndex,
         int                     *handleFlags,
         double                  *min,
         double                  *max,
         [[LXtVector (index)|LXtVector]]                plane,
         [[LXtVector (index)|LXtVector]]                offset);
 
         [[LXxMETHOD (index)|LXxMETHOD]](  [[LxResult (index)|LxResult]],
 HandleChannel) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         int                      handleIndex,
         int                     *chanIndex);
 
         [[LXxMETHOD (index)|LXxMETHOD]](  [[LxResult (index)|LxResult]],
 HandleValueToPosition) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         int                      handleIndex,
         double                  *chanValue,
         [[LXtVector (index)|LXtVector]]                position);
 
         [[LXxMETHOD (index)|LXxMETHOD]](  [[LxResult (index)|LxResult]],
 HandlePositionToValue) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         int                      handleIndex,
         [[LXtVector (index)|LXtVector]]                position,
         double                  *chanValue);
</syntaxhighlight>

<span id="C8"></span>
<span id="S1.3"></span>
=== Tools ===

When tools are selected, they can affect the way that input happens in the 3D views.  Tool object present an ILxToolModel interface which allows them to participate in mouse input and direct manipulation.  Internal tools implemented as ToolObj's can also have model interfaces attached.

===== (8) SDK: LXu_TOOLMODEL define =====

<syntaxhighlight>
 #define [[LXu_TOOLMODEL (index)|LXu_TOOLMODEL]]   "6E3DCFCE-F8BF-43EB-9D2E-617070574736"</syntaxhighlight>

<span id="C9"></span>
<span id="S1.3.1"></span>
==== Flags ====

A tool's flags encode various interactive behaviors of the tool.  This value should not change.

===== (9) SDK: ToolModel::Flags =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( unsigned,
 Flags) (
         [[LXtObjectID (index)|LXtObjectID]]              self);
</syntaxhighlight>

<span id="C10"></span>
The flags contain masks for drawing and testing in different view coordinates. 3D space is the normal model or world coordinate system, and PIXEL is the pixel space for the GL viewport.  Tools with both flags set will be drawn twice in each viewport.

The MODELSPACE bit indicates that the tool will expect the draw and test functions to operate in raw Model space, rather than the View space, which is the apparent space in which the user is working. View space is just Model space transformed by the 'Construction Plane'.  Since users will expect tools to respect the altered coordinate system they have chosen, it is rare that a tool would want to forgo this transformation. For tools that will work directly with mesh coordinates, however, this flag can be useful. The Model Space to View Space transform is available in the Xfrm packet of the tool vector.

===== (10) SDK: LXfTMOD_MODELSPACE, etc. defines =====

<syntaxhighlight>
 #define [[LXfTMOD_MODELSPACE (index)|LXfTMOD_MODELSPACE]]       0x00000004
 #define [[LXfTMOD_DRAW_3D (index)|LXfTMOD_DRAW_3D]]          0x00000010
 #define [[LXfTMOD_DRAW_PIXEL (index)|LXfTMOD_DRAW_PIXEL]]       0x00000020
</syntaxhighlight>

<span id="C11"></span>
The flags also contain masks for the different input behaviors.  I0 is the primary input and I1 is the secondary input (mapped to left and right buttons), the tool can ask for input on either of these or indicate that it wants automatic attribute hauling.  The other two flags can be used to trigger certain input changes, for brush-type and curve-type tools.

===== (11) SDK: LXfTMOD_I0_INPUT, etc. defines =====

<syntaxhighlight>
 #define [[LXfTMOD_I0_INPUT (index)|LXfTMOD_I0_INPUT]]         0x00000040
 #define [[LXfTMOD_I0_ATTRHAUL (index)|LXfTMOD_I0_ATTRHAUL]]      0x00000080
 #define [[LXfTMOD_I1_INPUT (index)|LXfTMOD_I1_INPUT]]         0x00000100
 #define [[LXfTMOD_I1_ATTRHAUL (index)|LXfTMOD_I1_ATTRHAUL]]      0x00000200
 #define [[LXfTMOD_I_CURVE (index)|LXfTMOD_I_CURVE]]          0x00000400
 #define [[LXfTMOD_I_BRUSH (index)|LXfTMOD_I_BRUSH]]          0x00000800
 #define [[LXfTMOD_I_GENERAL (index)|LXfTMOD_I_GENERAL]]        0x00001000
</syntaxhighlight>

<span id="C12"></span>
Finally, the flags contain masks to identify the tool type which is then mapped to an input pattern. For the input pattern, we can derive the falloff information from the vector type, so we just need to know the reset and brush behaviors.
{| class="wikitable"
 |-
 |BRUSHRESET
 | This is used for tools that want to autoreset for each brush stroke (like the push tool
 |-
 |NEEDHAUL
 | Tools without handles or that require hauling input should say so with the NEEDSHAUL flag. This will prevent hauling from being disabled by a tool preset flag.
 |-
 |ROLLOVERS 
 | Set if the handles should draw highlighted when the mouse moves over them.
 |-
 |AUTORESET
 | Apaprently distinguishes between transform and general tools...
 |-
 |HANDLERESET
 | This flag causes the tool to be restarted each time a handle is clicked.
 |-
 |DRAW_INACTIVE
 | When set, the draw function is called even if the tool is not active. Similarly, clicking on the drawn handle of such an inactive tool will activate the tool and start dragging the handle.
 |-
 |I0_NOSELECT
 |
 |-
 |I1_NOSELECT
 | Don't select when an INPUT or ATTRHAUL event is received, effectively blocking "select through" (I think).
 |-
 |AUTOACTIVATE
 |
 |-
 |SELECTTRHOUGH
 | These set the initial tool modes, which can then be overridden from tool presets.
 |-
 |NOCLONE
 | This should be set when clone is reset.
 |-
 |NODELTA
 | When set, the mouse pointer remains visible and the tool does not operate in delta mode, meaning that it is constrainted to the bounds of the screen.  Useful for 2D operations that should track the true mouse position, as opposed to 3D operations where edge of the screen would be in the way.
|}

===== (12) SDK: LXfTMOD_BRUSHRESET, etc. defines =====

<syntaxhighlight>
 #define [[LXfTMOD_BRUSHRESET (index)|LXfTMOD_BRUSHRESET]]       0x00002000
 #define [[LXfTMOD_INITAGAIN (index)|LXfTMOD_INITAGAIN]]        0x00004000
 #define [[LXfTMOD_NEEDSHAUL (index)|LXfTMOD_NEEDSHAUL]]        0x00008000
 #define [[LXfTMOD_ROLLOVERS (index)|LXfTMOD_ROLLOVERS]]        0x00010000
 #define [[LXfTMOD_AUTORESET (index)|LXfTMOD_AUTORESET]]        0x00020000
 #define [[LXfTMOD_HANDLERESET (index)|LXfTMOD_HANDLERESET]]      0x00040000
 #define [[LXfTMOD_DRAW_INACTIVE (index)|LXfTMOD_DRAW_INACTIVE]]    0x00080000
 
 #define [[LXfTMOD_I0_NOSELECT (index)|LXfTMOD_I0_NOSELECT]]      0x00100000
 #define [[LXfTMOD_I1_NOSELECT (index)|LXfTMOD_I1_NOSELECT]]      0x00200000
 
 #define [[LXfTMOD_AUTOACTIVATE (index)|LXfTMOD_AUTOACTIVATE]]     0x00400000
 #define [[LXfTMOD_SELECTTHROUGH (index)|LXfTMOD_SELECTTHROUGH]]    0x00800000
 
 #define [[LXfTMOD_NOCLONE (index)|LXfTMOD_NOCLONE]]          0x01000000
 #define [[LXfTMOD_NODELTA (index)|LXfTMOD_NODELTA]]          0x02000000
</syntaxhighlight>

<span id="C13"></span>
<span id="S1.3.2"></span>
==== Drawing ====

Tools can draw themselves in graphic viewports with the Draw() and Test() methods.  Draw() is called to update the appearance of the tool (as a stroked model in the view).  Test() is called when performing hit testing on the tool, and can be substantially the same as the draw method as long as part ID's are set for the tool's handles.

===== (13) SDK: ToolModel::Draw, etc. =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Draw) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              stroke,
         int                      flags);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Test) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              stroke,
         int                      flags);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Filter) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              adjust);
</syntaxhighlight>

The Filter() method will be called during both drawing and input processing. This function should modify the tool vector to make available packets needed by downstream tools.  In principle this same function can serve both needs, although input event packets can be queried to find the context for the call.
<span id="C14"></span>
<span id="S1.3.3"></span>
==== Input Event Handling ====

Event handling passes input events through the pipeline, allowing every tool to process the tool vector until the primary tool is processed.  The primary tool is the one selected for hauling and 'live' input.  State changes are handled using special methods.  In general each tool will get a special state event, then either a Filter() call, or a call to one of the Down(), Move(), or Up() methods.

The Initialize() method is called to set up tool attributes when they need to integrate into an active pipeline, typically when the tool activates due to a mouse-down event.  The tool needs to compute default state based on the flags.  DIRECT means that the tool itself is the focus of user action, and EVENT means that this is the result of a viewport event.  AGAIN is set only if the tool sets the INITAGAIN bit in its flags, in which case it means that the tool has user-set values but is being initialized again. BRUSH means that the tool is used in conjunction with a brush tool, which maybe change the way the tool is intialized. PROCEDURAL bit is set when the Initialize() method is called for the procedural tool operator.

===== (14) SDK: ToolModel::Initialize =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Initialize) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              adjust,
         unsigned int             flags);
</syntaxhighlight>

<span id="C15"></span>
===== (15) SDK: LXfINITIALIZE_DIRECT, etc. defines =====

<syntaxhighlight>
 #define [[LXfINITIALIZE_DIRECT (index)|LXfINITIALIZE_DIRECT]]     0x01
 #define [[LXfINITIALIZE_EVENT (index)|LXfINITIALIZE_EVENT]]      0x02
 #define [[LXfINITIALIZE_AGAIN (index)|LXfINITIALIZE_AGAIN]]      0x04
 #define [[LXfINITIALIZE_BRUSH (index)|LXfINITIALIZE_BRUSH]]      0x08
 #define [[LXfINITIALIZE_PROCEDURAL (index)|LXfINITIALIZE_PROCEDURAL]] 0x10
</syntaxhighlight>

<span id="C16"></span>
The ILxToolModel directly tracks mouse movement via Down, Move, and Up event callbacks, as well as tracking the part number and hit location of mouse events on handles.  The parts are prioritized based on the part number (available in the tool vector), with the highest part taking the hit.

===== (16) SDK: ToolModel::Down, etc. =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 Down) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              adjust);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Move) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              adjust);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Up) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              adjust);
</syntaxhighlight>

{| class="wikitable"
 |-
 |Down
 | This function is called with the initial mouse-down event for tool input event processing.  It should return LXe_TRUE to indicate event processing should continue via the 'Move' and 'Up' methods, or LXe_TRUE to initiate handle-based event processing.
 |-
 |Move
 | This function is called repeatedly with updated position info that tracks the mouse movement during raw input event processing.
 |-
 |Up
 | This function is called at the end of a user interaction, signified by the release of the mouse button that started the whole thing.
|}
<span id="C17"></span>
<span id="S1.3.4"></span>
==== Hauling Attributes ====

Some attributes can have automatic hauling behavior.  Tools may expose up to 2 attributes for automatic hauling: the first attribute (index &#x3d; 0) is displayed with horizontal graduations, the seconde one (index &#x3d; 1) is displayed vertically. The 'haul' method returns the attribute name given its index.

===== (17) SDK: ToolModel::Haul =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( const char *,
 Haul) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         unsigned int             index);
</syntaxhighlight>

<span id="C18"></span>
<span id="S1.3.5"></span>
==== Tool Tips ====

Help or tips messages can be displayed during tool interaction using the 'Help' method.  This function gets the tool vector and returns a pointer to a string.

===== (18) SDK: ToolModel::Help =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( const char *,
 Help) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts);
</syntaxhighlight>

<span id="C19"></span>
<span id="S1.3.6"></span>
==== Enable ====

Tell whether tool can be set. This method retuns LXe_DISABLED if the tool is not ready to run and it also set the reason to the message. Otherwise it returns LXe_OK.

===== (19) SDK: ToolModel::Enable =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 Enable) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              msg);
</syntaxhighlight>

<span id="C20"></span>
<span id="S1.3.7"></span>
==== Drop ====

Called when the tool is dropped.

===== (20) SDK: ToolModel::Drop =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 Drop) (
         [[LXtObjectID (index)|LXtObjectID]]              self);
</syntaxhighlight>

<span id="C21"></span>
<span id="S1.3.8"></span>
==== Track ====

Tool can also have a tracking function associated with them. The function will be called during mouse movement over a viewport with one of the event types below.

===== (21) SDK: LXfTRACK_ENTER, etc. defines (types) =====

<syntaxhighlight>
 #define [[LXfTRACK_ENTER (index)|LXfTRACK_ENTER]]          0x00
 #define [[LXfTRACK_MOVE (index)|LXfTRACK_MOVE]]           0x01
 #define [[LXfTRACK_EXIT (index)|LXfTRACK_EXIT]]           0x02
</syntaxhighlight>

<span id="C22"></span>
===== (22) SDK: ToolModel::Track =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 Track) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         unsigned int             eventType);
</syntaxhighlight>

<span id="C23"></span>
Tool can specify how to select elements for selection rollover. LAZY allows the tool lazy selection regardress the current lazy selection mode. VERX, EDGE and POLY are components to be pre highlighting. If nothing is specified, the default selection settings will be used. LOOP1 and LOOP2 works with EDGE mask to draw edge loop. RAYCAST always uses the hit testing regardress the view shading mode.

===== (23) SDK: LXfTRACK_LAZY, etc. defines (types) =====

<syntaxhighlight>
 #define [[LXfTRACK_LAZY (index)|LXfTRACK_LAZY]]           0x000040
 #define [[LXfTRACK_VERX (index)|LXfTRACK_VERX]]           0x000100
 #define [[LXfTRACK_EDGE (index)|LXfTRACK_EDGE]]           0x000200
 #define [[LXfTRACK_POLY (index)|LXfTRACK_POLY]]           0x000400
 #define [[LXfTRACK_LOOP1 (index)|LXfTRACK_LOOP1]]          0x000800
 #define [[LXfTRACK_LOOP2 (index)|LXfTRACK_LOOP2]]          0x001000
 #define [[LXfTRACK_RAYCAST (index)|LXfTRACK_RAYCAST]]        0x002000
 #define [[LXfTRACK_BK_RAYCAST (index)|LXfTRACK_BK_RAYCAST]]     0x004000
 #define [[LXfTRACK_ACTIVE (index)|LXfTRACK_ACTIVE]]         0x008000
 #define [[LXfTRACK_INACTIVE (index)|LXfTRACK_INACTIVE]]       0x010000
</syntaxhighlight>

<span id="C24"></span>
===== (24) SDK: ToolModel::TrackFlags =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 TrackFlags) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         unsigned int            *flags);
</syntaxhighlight>

<span id="C25"></span>
<span id="S1.3.9"></span>
==== Post ====

===== (25) SDK: ToolModel::Post =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 Post) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts);
</syntaxhighlight>

<span id="C26"></span>
<span id="S1.3.10"></span>
==== Test Viewport Type ====

Test if the tool can be operated on the given viewport type. This meshod should return LXe_FALSE if the tool does not work on the viewport type. Otherwise it returns LXe_TRUE.

===== (26) SDK: ToolModel::TestType =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 TestType) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         LXtID4                   type);
</syntaxhighlight>

<span id="C27"></span>
<span id="S1.3.11"></span>
==== Tooltips ====

This function allows clients to return a tooltip for the given tool part number.

===== (27) SDK: ToolModel::Tooltip =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( const char *,
 Tooltip) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         int                      part);
</syntaxhighlight>

<span id="C28"></span>
Empty ToolModel Python user class.

===== (28) PY: empty ToolModel user class =====

<syntaxhighlight>
 pass
</syntaxhighlight>

<span id="C29"></span>
<span id="S1.3.12"></span>
==== ILxToolModel3 (Legacy Interface) ====

This interface was retired in modo 904, and was replaced with an updated one that adds "adjust" argument to Filter method.

===== (29) SDK: LXu_TOOLMODEL3 define =====

<syntaxhighlight>
 #define [[LXu_TOOLMODEL3 (index)|LXu_TOOLMODEL3]]  "27DB58F5-5C0C-4CF7-B064-6B07188E9813"</syntaxhighlight>

<span id="C30"></span>
===== (30) SDK: ToolModel3::Flags, etc. =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( unsigned,
 Flags) (
         [[LXtObjectID (index)|LXtObjectID]]              self);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Draw) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              stroke,
         int                      flags);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Test) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              stroke,
         int                      flags);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Filter) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Initialize) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              adjust,
         unsigned int             flags);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 Down) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              adjust);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Move) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              adjust);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Up) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              adjust);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( const char *,
 Haul) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         unsigned int             index);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( const char *,
 Help) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 Enable) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              msg);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 Drop) (
         [[LXtObjectID (index)|LXtObjectID]]              self);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 Track) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         unsigned int             eventType);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 TrackFlags) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         unsigned int            *flags);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 Post) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 TestType) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         LXtID4                   type);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( const char *,
 Tooltip) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         int                      part);
</syntaxhighlight>

<span id="C31"></span>
<span id="S1.3.13"></span>
==== ILxToolModel2 (Legacy Interface) ====

This interface was retired in modo 901, and was replaced with an updated one that adds a method for tooltips.

===== (31) SDK: LXu_TOOLMODEL2 define =====

<syntaxhighlight>
 #define [[LXu_TOOLMODEL2 (index)|LXu_TOOLMODEL2]]  "B70B1F15-137A-4716-A893-1AC416C547E9"</syntaxhighlight>

<span id="C32"></span>
===== (32) SDK: ToolModel2::Flags, etc. =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( unsigned,
 Flags) (
         [[LXtObjectID (index)|LXtObjectID]]              self);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Draw) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              stroke,
         int                      flags);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Test) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              stroke,
         int                      flags);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Filter) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Initialize) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              adjust,
         unsigned int             flags);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 Down) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              adjust);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Move) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              adjust);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Up) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              adjust);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( const char *,
 Haul) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         unsigned int             index);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( const char *,
 Help) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 Enable) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              msg);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 Drop) (
         [[LXtObjectID (index)|LXtObjectID]]              self);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 Track) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         unsigned int             eventType);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 TrackFlags) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         unsigned int            *flags);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 Post) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 TestType) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         LXtID4                   type);
</syntaxhighlight>

<span id="C33"></span>
<span id="S1.3.14"></span>
==== ILxToolModel1 (Legacy Interface) ====

This interface was retired in modo 701, and was replaced with an updated one that adds a few more methods.

===== (33) SDK: LXu_TOOLMODEL1 define =====

<syntaxhighlight>
 #define [[LXu_TOOLMODEL1 (index)|LXu_TOOLMODEL1]]  "EECE6570-AD5F-4190-AFA7-15067500454F"</syntaxhighlight>

<span id="C34"></span>
===== (34) SDK: ToolModel1::Flags, etc. =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( unsigned,
 Flags) (
         [[LXtObjectID (index)|LXtObjectID]]              self);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Draw) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              stroke,
         int                      flags);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Test) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              stroke,
         int                      flags);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Filter) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Initialize) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              adjust,
         unsigned int             flags);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 Down) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              adjust);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Move) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              adjust);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Up) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         [[LXtObjectID (index)|LXtObjectID]]              adjust);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( const char *,
 Haul) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         unsigned int             index);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( const char *,
 Help) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 Enable) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              msg);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 Drop) (
         [[LXtObjectID (index)|LXtObjectID]]              self);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 Track) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts,
         unsigned int             eventType);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 TrackFlags) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         unsigned int            *flags);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( [[LxResult (index)|LxResult]],
 Post) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              vts);
</syntaxhighlight>

<span id="C35"></span>
<span id="S1.3.15"></span>
==== Attribute Adjustments ====

During event processing, the tool should not modify its own attributes directly.  Instead it should adjust its own values through the adjust tool interface which allows the atribute changes to be scripted and undoable. The functions are similar to those found in the ILxAttributes interface, but they are for write only.  The Value() method is passed a value object for the attribute which will probably be copied and converted into text.

===== (35) SDK: AdjustTool::Value, etc. =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Value) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         unsigned int             index,
         [[LXtObjectID (index)|LXtObjectID]]              val);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 SetInt) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         unsigned int             index,
         int                      val);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 SetFlt) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         unsigned int             index,
         double                   val);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 SetString) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         unsigned int             index,
         const char              *val);
</syntaxhighlight>

<span id="C36"></span>
Additional methods allow the tool to signal other changes during interaction. Invalidate() causes the tools model to redraw, and Lock() indicates that the next attribute change will have side effects and cannot be merged with previous changes.

===== (36) SDK: AdjustTool::Lock, etc. =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Lock) (
         [[LXtObjectID (index)|LXtObjectID]]              self);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Invalidate) (
         [[LXtObjectID (index)|LXtObjectID]]              self);
 
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Update) (
         [[LXtObjectID (index)|LXtObjectID]]              self);
</syntaxhighlight>

<span id="C37"></span>
This interface has an ID, but it's never used by the client since it's not polymorphic with anything.

===== (37) SDK: LXu_ADJUSTTOOL define =====

<syntaxhighlight>
 #define [[LXu_ADJUSTTOOL (index)|LXu_ADJUSTTOOL]]  "26E85301-8165-4FF3-AF26-392A03C9E1E7"</syntaxhighlight>

<span id="C38"></span>
===== (38) SDK: empty AdjustTool User Class =====

<span id="C39"></span>
Empty AdjustTool Python user class.

===== (39) PY: empty AdjustTool user class =====

<syntaxhighlight>
 pass
</syntaxhighlight>

<span id="C40"></span>
<span id="S1.3.16"></span>
==== Navigation Listener ====

Navigation listener is a global port to be informed of camera navigation event.

'Down' is called when mouse is down. 'view' is ILxView3D object of navigation viewport. 'item' is ILxItem1 object when navigation viewport is camera or light or preview.

===== (40) SDK: NavigationListener::Down =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Down) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              view,
         [[LXtObjectID (index)|LXtObjectID]]              item);
</syntaxhighlight>

<span id="C41"></span>
'Move' is called when mouse is move. 'pos', 'rot' and 'zoom' are current view tranform in hot mode in camera or preview navigation. The navigating transform type is set by 'hot' mask as LXfNAV_HOT.

===== (41) SDK: NavigationListener::Move =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Move) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              view,
         [[LXtObjectID (index)|LXtObjectID]]              item,
         unsigned                 hot,
         const [[LXtVector (index)|LXtVector]]          pos,
         const LXtMatrix          rot,
         double                   zoom);
</syntaxhighlight>

<span id="C42"></span>
'Up' is called when mouse is up.

===== (42) SDK: NavigationListener::Up =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Up) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              view,
         [[LXtObjectID (index)|LXtObjectID]]              item);
</syntaxhighlight>

<span id="C43"></span>
'Delta' is called at the end of navigation by a navigation wiget.

===== (43) SDK: NavigationListener::Delta =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Delta) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              view,
         [[LXtObjectID (index)|LXtObjectID]]              item,
         unsigned                 hot,
         const [[LXtVector (index)|LXtVector]]          pos,
         const LXtMatrix          rot,
         double                   zoom);
</syntaxhighlight>

<span id="C44"></span>
'Wheel' is called at the end of mouse wheel event.

===== (44) SDK: NavigationListener::Wheel =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 Wheel) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              view,
         [[LXtObjectID (index)|LXtObjectID]]              item);
</syntaxhighlight>

<span id="C45"></span>
'HotSyncPre' is called when the current hot mode is on and the new  mode is off before calling the navigation action in 'Move' or 'Delta'  event.

===== (45) SDK: NavigationListener::HotSyncPre =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 HotSyncPre) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              view,
         [[LXtObjectID (index)|LXtObjectID]]              item);
</syntaxhighlight>

<span id="C46"></span>
'HotSyncPost' is called when the current hot mode is on and the new  mode is off after the navigation action in 'Move' or 'Delta' event.

===== (46) SDK: NavigationListener::HotSyncPost =====

<syntaxhighlight>
         [[LXxMETHOD (index)|LXxMETHOD]]( void,
 HotSyncPost) (
         [[LXtObjectID (index)|LXtObjectID]]              self,
         [[LXtObjectID (index)|LXtObjectID]]              view,
         [[LXtObjectID (index)|LXtObjectID]]              item);
</syntaxhighlight>

<span id="C47"></span>
===== (47) SDK: LXfNAV_HOT_POS, etc. defines =====

<syntaxhighlight>
 #define [[LXfNAV_HOT_POS (index)|LXfNAV_HOT_POS]]                  0x01
 #define [[LXfNAV_HOT_ROT (index)|LXfNAV_HOT_ROT]]                  0x02
 #define [[LXfNAV_HOT_ZOOM (index)|LXfNAV_HOT_ZOOM]]                 0x04
</syntaxhighlight>

<span id="C48"></span>
===== (48) SDK: LXu_NAVIGATIONLISTENER define =====

<syntaxhighlight>
 #define [[LXu_NAVIGATIONLISTENER (index)|LXu_NAVIGATIONLISTENER]]  "61724B7C-59DE-40F7-B260-8C71D8FE9710"</syntaxhighlight>

<span id="C49"></span>
Empty NavigationListener Python user class.

===== (49) PY: empty NavigationListener user class =====

<syntaxhighlight>
 pass
</syntaxhighlight>

[[Category:Headers]]
[[Category:Autogenerated]]