SIGetRigidCns

Creates a rigid body constraint.

Note: This command uses output arguments. C# and some scripting languages (such as JScript, PerlScript and Python) don't support arguments passed by reference so you need to use the best workaround for your situation:

For scripting languages this command returns an ISIVTCollection which you can use to get the output arguments.

For C# you can use the XSIApplication.ExecuteCommand method to call this command. ExecuteCommand packs the output arguments into a C# System.Object containing an Array of the output arguments (see Calling Commands from C#).

Scripting Syntax

SIGetRigidCns( PresetObj, [FileName], [Name], [Parent], [AddToScene], [Value], [Primitive] );

Parameters

Parameter Type Description

PresetObj String or a preset object (see SIGetPreset) Any preset from Control Object Primitives

FileName String If creating a custom constraint, this is the type name of the constraint.

Name String Name given to the new constraint.

Parent String Name of an existing object to use as the parent of the new primitive.

AddToScene Boolean True to create the object in the scene.
Default Value: True

Value X3DObject Returns the 3D object created for the primitive.

Primitive Primitive Returns the implicit primitive object.

Parameter	Type	Description
PresetObj	String or a preset object (see SIGetPreset)	Any preset from Control Object Primitives
FileName	String	If creating a custom constraint, this is the type name of the constraint.
Name	String	Name given to the new constraint.
Parent	String	Name of an existing object to use as the parent of the new primitive.
AddToScene	Boolean	True to create the object in the scene. Default Value: True
Value	X3DObject	Returns the 3D object created for the primitive.
Primitive	Primitive	Returns the implicit primitive object.