ShapeGroupName (ShapeKey)

Introduced

5.0

Description

Returns or sets a String representing the name of the shape group to which the shape key object belongs. Shape groups are a way to semantically organize shape keys within a given cluster. A shape key can be part of only one shape group. This organization is visible within the shape manager view.

Note: If you attempt to assign a non-existing shape group name to a shape key, a new shape group will be created.

C# Syntax

    // get accessor
    String rtn = ShapeKey.ShapeGroupName;

    // set accessor
    ShapeKey.ShapeGroupName = String;

Examples

JScript Example

    /* ------------------------------------------------------------------------------

       This example demonstrates how to get and set shape group identifiers.

    ------------------------------------------------------------------------------ */
    NewScene(null, false);
    CreatePrim("Cone", "MeshSurface", null, null);
    ActivateVertexSelTool(null);
    ActivateVertexSelTool(null);
    SelectGeometryComponents("cone.pnt[1]");
    Translate(null, -4.77865299554318, 0, 0, siRelative, siGlobal, siObj, siXYZ, null, null, null, null, null, null, null, null, null, 1);
    StoreShapeKey("cone.pnt[1]", "", siShapeLocalReferenceMode, 1, 0, 0, siShapeContentPrimaryShape, false);
    SelectFilter("object");
    Translate(null, 9.36145955684278, 0, 0, siRelative, siGlobal, siObj, siXYZ, null, null, null, null, null, null, null, null, null, 1);
    StoreShapeKey("cone.polymsh.cls.Shape", "", siShapeLocalReferenceMode, 1, 0, 0, siShapeContentPrimaryShape, false);

    SelectObj("cone", null, true);
    var oShapeCluster = Selection(0).ActivePrimitive.Geometry.Clusters(0);
    var oShapeKey0 = oShapeCluster.Properties("ShapeKey");
    var oShapeKey1 = oShapeCluster.Properties("ShapeKey1");

    // Logs the default shape group
    LogMessage(oShapeKey0.ShapeGroupName);
    LogMessage(oShapeKey1.ShapeGroupName);

    // Changing the shape group.
    oShapeKey0.ShapeGroupName = "MyShapeGroup";
    oShapeKey1.ShapeGroupName = "MyShapeGroup";

    // Logs "MyShapeGroup" for both keys.
    LogMessage(oShapeKey0.ShapeGroupName);
    LogMessage(oShapeKey1.ShapeGroupName);

See Also

CreateShapeGroup | SetShapeGroup

Autodesk Softimage v7.5