SaveShapeKey
Creates a shape key for the current shape and adds it to the
model's list of shape sources (in the model's Mixer > Sources
> Shape folder). Also adds an instance of the shape key as a
shape clip on a track in the animation mixer. The track is
contained in a compound clip corresponding to the cluster.
This is the scripting equivalent of storing a shape key and then
immediately bringing it into the animation mixer as a clip with
ApplyShapeKey.
With shape animation (sometimes called morphing), you can change
the shape of an object over time, animating the geometrical shape
of an object using clusters of points (clusters made of polygons or
edges are not supported). You can use surface (NURBS) or polygon
objects to create shape animation, or even curves and lattices--any
geometry that has a static number of points.
In Softimage, all shape animation is done on clusters. This means
that you can create different clusters on an object and create
shape keys for each of them; or you can treat a complete object as
one cluster and save shape keys for it. For more information on
clusters in general, see
the Softimage user guide.
oReturn = SaveShapeKey( InputObj, [Compound], [Track], [Time], [Duration], [Mode], [Name], [Overwrite], [RefMode] ); |
Returns the created shape animation clip as a Clip object.
| Parameter | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| InputObj | XSICollection | The geometry or cluster to create the clip from. | ||||||||||||
| Compound | XSICollection | The compound container (track owner) to add this clip to. | ||||||||||||
| Track | XSICollection | The track to add this clip to. | ||||||||||||
| Time | Double | The time at which to add the clip.
Default Value: If not supplied, the key frame will be used. |
||||||||||||
| Duration | Double | The length of the clip in frames.
Default Value: If not supplied, the time stored in the source is used. |
||||||||||||
| Mode | Long | The shape clip authoring mode (0=instance only, 1=weight mix,
2=transition, 3=transition cardinal, 4=use default).
Default Value: If not supplied try to figure out the "right" mode.
|
||||||||||||
| Name | String | The name to use for the new clip.
Default Value: If no name is supplied, then a variation on the source name will be used. |
||||||||||||
| Overwrite | Long | The behaviour when a shape clip already exist at the key time
(0=prompt user, 1=replace, 2=add, 3=skip).
Default Value: If not supplied prompt user (in batch mode the default is replace).
|
||||||||||||
| RefMode | siShapeReferenceMode | The reference mode of the shape key created
Default Value: siShapeLocalReferenceMode |
CreatePrim "Sphere", "NurbsSurface" SetSelFilter "Point" AddToSelection "sphere.pnt[(5,4),(6,4),(7,4),(0,5),(1,5),(2,5),(3,5),(4,5),(5,5),(6,5),(7,5),(0,6),(1,6),(2,6),(3,6)]" CreateCluster SaveShapeKey "sphere.surfmsh.cls.Point" , , , 10, , 1 , "MyShapeClip" |