SetCurrentReferencePlane

Introduced

v1.5

Description

Sets the current reference plane (the plane used for transformations/drawing). Appropriate reference planes can be found in the RefPlanes folder, under Project > Data

Scripting Syntax

SetCurrentReferencePlane( Value );

Parameters

Parameter Type Description
Value String Name of reference plane to use.

Possible Values:

Description:

RefPlanes.View View plane
RefPlanes.XY XY plane
RefPlanes.XZ XZ plane
RefPlanes.YZ YZ plane
RefPlanes.Transform Transform plane

Examples

VBScript Example

'

'	This example shows how to set the reference plane from the  

'	data stored in the refplane transform 

'

NewScene

TranslateTool

'Create a sphere 

CreatePrim "Sphere", "MeshSurface" 

'Use reference plane XZ

SetCurrentReferencePlane "RefPlanes.XZ" 

'Set-up snapping to the reference plane 

'Set plane reference mode in MCP 

SetValue "Preferences.SnapProperties.Enable", True 

SetValue "Preferences.SnapProperties.EnableGrid", True 

SetUserPref "3D_TRANSFO_REFERENTIAL_CHANGED", 7 

MsgBox "Translate the sphere - note it is locked to the XZ reference plane."

'NOTE: you can set back the current reference plane to  

'the one created from CreateReferencePlane or SetTransientReferencePlane 

'by doing SetCurrentReferencePlane "RefPlanes.Transform"

See Also

SetCurrentPass SetCurrentLayer SetTransientReferencePlane SetReferencePlane CreateReferencePlane