UnfoldRemoveFromCut
 
 
 

UnfoldRemoveFromCut

Introduced

v7.5

Description

Removes the specified edge list(s) from the Unfold Property cutting line.

Scripting Syntax

oBoolean = UnfoldRemoveFromCut( UnfoldProperty, [EdgeList(s)] );

Return Value

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

Parameters

Parameter Type Description
UnfoldProperty Property The Unfold property from which you want to remove the new cut(s).
EdgeList(s) List of edges or EdgeCollection Edges to be removed from the cutting line definition.

Default Value: If not specified, the current selection is used.

Examples

JScript Example

/*
        This example demonstrates how to remove edges from the
        cutting line of an Unfold property
*/
NewScene(null, false);
var g = CreatePrim("Grid", "MeshSurface");
// Set up an Unfold property on the grid with a cutting line
UnfoldApply("grid");
var up = g.Properties("Unfold");
UnfoldSetCut(up, "grid.edge[14,34,51,68,71,73,75]");
LogCuts(up);
// Remove 2 edges from the cutting line definition
UnfoldRemoveFromCut(up, "grid.edge[73,75]");
LogCuts(up);
// -------------------------
//
//      Expected results
//
// INFO : grid cutting line: grid.edge[14,34,51,68,71,73,75]
// INFO : grid cutting line: grid.edge[14,34,51,68,71]
// -------------------------
//
//      Helper function
//
function LogCuts( in_prop )
{
        var a = Application;
        UnfoldSelectCut(in_prop);
        if (a.Selection.Count) { 
                a.LogMessage(in_prop.Parent3DObject.Name + " cutting line: " + a.Selection(0)); 
        } else { 
                a.LogMessage(in_prop.Parent3DObject.Name + " cutting line: [empty]"); 
        }
        
}

See Also

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