CreateSymmetryMappingTemplate

Introduced

v2.0

Description

Creates a symmetry mapping template under the model that is used to define the object's symmetry. A symmetry mapping template creates a relation between deformers.

Scripting Syntax

oReturn = CreateSymmetryMappingTemplate( [InputObj], [FillTemplate], [Symmetry Plane], [CreateSymmetryMap] );

Return Value

Returns the new symmetry mapping template.

Parameters

Parameter Type Description
InputObj String List of objects

Default Value: Current selection

FillTemplate Boolean Do we want to automatically fill the object symmetry map based on input symmetry plane

Default Value: True

Symmetry Plane Integer Which symmetry plane should be used to generate the symmetry map

Default Value: 0 (YZ plane)

Possible Values:

Description:

0 YZ plane.
1 XZ plane.
2 XY plane.
CreateSymmetryMap Boolean Do we want to create a new symmetry map property mapping geometry

Default Value: True

Examples

VBScript Example

'

' This example creates 2 symmetrical bones and envelopes them inside a 

' sphere. Then it creates a symmetry mapping template for the envelope

' and finishes by displaying the new template's property page.

'

' Create a sphere that we will use as an envelope

set oEnvelope = CreatePrim( "Sphere", "MeshSurface" )

' Create the bones that will be used to deform the envelope

set oRoot1 = Create2DSkeleton( 0.000, 3.000, 0.000, -2.000, 1.000, _

								0.000, 0.000, 0.000, 0.000, 4 )

AppendBone , -2.000, -2.000, 0.000

set oRoot2 = Create2DSkeleton( 0.000, 3.000, 0.000, 2.000, 1.000, _

								0.000, 0.000, 0.000, 0.000, 4 )

AppendBone , 2.000, -2.000, 0.000

' Assign the envelope to the skeleton (notice here I have used "B:"

' to indicate that I want to select the objects in Branch mode so that

' the connection set will include the effectors as well as the roots; 

' otherwise the flexible envelope will not be assigned properly.

ApplyFlexEnv oEnvelope & ";B:" & oRoot1 & ",B:" & oRoot2, False

' Create a symmetry mapping template 

set oTemplate = CreateSymmetryMappingTemplate( oEnvelope, True, 0, True )

' Display the property page for the new template

InspectObj oTemplate

See Also

AddMappingRule DeleteMappingRule DeleteMappingRule GetNumMappingRules GetMappingRule SymEnvWeight