Scripting: SICreateRefPlane

SICreateRefPlane

Introduced

v1.5

Description

Creates a new reference plane based on the selection. It does not set this new reference plane as the active reference plane.

Scripting Syntax

oReturn = SICreateRefPlane( [InputObjs] );

Return Value

Returns an XSICollection object that contains the list of created reference planes.

Parameters

Parameter	Type	Description
InputObjs	String	List of objects. Default Value: Current selection.

Examples

VBScript Example

'
'       This example shows how to create a reference plane and use it for snapping
'
NewScene
CreatePrim "Sphere", "MeshSurface"
CreatePrim "Grid", "MeshSurface"
Rotate , 45, 0, 0, siAbsolute, siParent, siObj, siX
Rotate , 0, 0, -45, siRelative, siLocal, siObj, siXYZ, , , , , , , , 2
'Create reference plane in RefPlanes.ReferencePlane 
SICreateRefPlane "grid"
'SICreateRefPlane creates a reference plane and does not make it the active
'reference plane. To do so, SetCurrentReferencePlane must be called.
SetCurrentReferencePlane "RefPlanes.ReferencePlane"
'Set snapping ON
'Activate plane reference mode in MCP
SelectObj "sphere", , True
SetValue "Preferences.SnapProperties.Enable", True
SetValue "Preferences.SnapProperties.EnableGrid", True
SetUserPref "3D_TRANSFO_REFERENTIAL_CHANGED", 7
MsgBox "Move the sphere around interactively.  It will snap to the reference plane defined by the grid."