Interface: WorkingPivot

Core Interfaces - Quick Navigation

The WorkingPivot Core Interface exposes the Working Pivot custom coordinate system feature to MAXScript.

Available in 3ds Max 2008 and higher.

Interface: WorkingPivot 

Properties:

WorkingPivot.EditMode : boolean : Read|Write   

When set to true , enters Working Pivot Edit mode and allows you to place the working point interactively using an Axis_Helper object created internally by the feature.

When set to false , exits Working Pivot Editing and removes the Axis_Helper object from the scene.

Corresponds to toggling the "Edit Working Pivot" checkbutton in the Working Pivot rollout of the Hierarchy Tab in the Command Panel.

WorkingPivot.UseMode : boolean : Read|Write 

When set to true , enables the Use Working Pivot mode which switches the reference coordinate system to the matrix defined by the working pivot in Edit mode.

When set to false, Use Working Pivot mode is turned off and the reference coordinate system is switched back to the previous settings.

Corresponds to toggling the "Use Working Pivot" checkbutton in the Working Pivot rollout of the Hierarchy Tab in the Command Panel.

WorkingPivot.AxisSize : float : Read|Write 

Get/set the size of theAxis_Helper object used as Working Pivot.

The size value is either in world units or screen pixels depending on the .AxisConstantScreenSize property.

Not exposed to the 3ds Max GUI.

Methods:

<matrix3>WorkingPivot.getTM() 

Returns the transformation matrix of the Working Pivot.

<void>WorkingPivot.setTM <matrix3>tm 

Sets the transformation matrix of the Working Pivot to the given matrix3 value. This can be used to reposition to Working Pivot using MAXScript.

<void>WorkingPivot.alignToView() 

Sets the transformation matrix of the Working Pivot to the viewport.

<void>WorkingPivot.resetTMToNode <node>node 

Sets the transformation matrix of the Working Pivot to the transformation matrix of the supplied node.

<void>WorkingPivot.setPlacePivotViewMode <boolean>on <boolean>alignToView 

Controls the state of the Place Pivot To View mode.

If the first argument is true, the Place Pivot To View mode will be enabled.

If the first argument is false, the Place Pivot To View mode will be disabled.

If the second argument is true, the Align To View option will be checked.

If the second argument is false, the Align To View option will be unchecked.

<boolean>WorkingPivot.getPlacePivotViewMode() 

Returns the state of the Place Pivot To View mode.

<void>WorkingPivot.setPlacePivotSurfaceMode <boolean>on <boolean>alignToView 

Controls the state of the Place Pivot To Surface mode.

If the first argument is true, the Place Pivot To Surface mode will be enabled.

If the first argument is false, the Place Pivot To Surface mode will be disabled.

If the second argument is true, the Align To View option will be checked.

If the second argument is false, the Align To View option will be unchecked.

<boolean>WorkingPivot.getPlacePivotSurfaceMode() 

Returns the state of the Place Pivot To Surface mode.

<boolean>WorkingPivot.getPlacePivotAlignToView() 

Returns the state of the Align To View option.

 Except where otherwise noted, this work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License. Please see the Autodesk Creative Commons FAQ for more information.