UnfoldClearCut

Introduced

7.5

Description

Clears the cutting line associated with the specified Unfold Property.

Warning: This clears the entire cutting line for the property, even if you specify just a portion of it. For example, if a sphere's cutting line was originally set at 'sphere.edge[0,1,2,3,4]' and you call this command with the Objects parameter set to 'sphere.edge[3,4]', the sphere will have no cutting line at all set for the specified Unfold property.

Scripting Syntax

    UnfoldClearCut( Unfold Property, [Objects] )

Parameters

Parameter | Type | Description
Unfold Property | Property | The Unfold property from which you want to clear the cut(s).
Objects | List of objects or X3DObject | Object(s) containing the cutting line that you want to be removed from the Unfold property. Default Value: If not specified, the current selection is used.

Return Value

Returns a Boolean reporting whether or not the command was successful.

Examples

JScript Example

    /*
       This example demonstrates how to set up, modify, and remove
       a cutting line for a grid on its Unfold property.
    */
    NewScene(null, false);
    var g = CreatePrim("Grid", "MeshSurface");

    // Apply the Unfold property to the grid and get a pointer to it
    UnfoldApply(g);
    var u = g.Properties("Unfold");

    // Set the cutting line using 7 edges and log it
    UnfoldSetCut(u, "grid.edge[14,34,51,68,71,73,75]");
    LogCuts(u);

    // Add edges 2 and 3 to the current cutting line and log it again
    UnfoldAddToCut("grid.Unfold", "grid.edge[2,3]");
    LogCuts(u);

    // Reset the cutting line
    UnfoldClearCut("grid.Unfold", "grid");
    LogCuts(u);

    // Launch Unfolding computations (since there's no cutting line
    // there's nothing to do, as you can see from the Texture Editor)
    UnfoldUpdate("grid.Unfold");
    OpenView("Texture Editor");

    // -------------------------
    //
    // Expected results
    //
    // INFO : Unfold cutting line: grid.edge[14,34,51,68,71,73,75]
    // INFO : Unfold cutting line: grid.edge[2,3,14,34,51,68,71,73,75]
    // INFO : Unfold cutting line: [empty]

    // -------------------------
    //
    // Helper function
    //
    function LogCuts( in_prop )
    {
       var a = Application;
       UnfoldSelectCut(in_prop);
       if (a.Selection.Count) {
           a.LogMessage(in_prop.Name + " cutting line: " + a.Selection(0));
       } else {
           a.LogMessage(in_prop.Name + " cutting line: [empty]");
       }

    }

See Also

UnfoldAddToCut | UnfoldAdjustUpdate | UnfoldApply | UnfoldApplySel
UnfoldPackUpdate | UnfoldRemoveFromCut | UnfoldSelectCut | UnfoldSetCut
UnfoldUpdate | Unfold Property Editor reference |  |

Autodesk Softimage v7.5