UnfoldApply

Introduced

v7.5

Categories

Unfold

Description

Applies an Unfold Property to the specified object(s) and/or group(s).

Scripting Syntax

oBoolean = UnfoldApply( [Object(s) and/or group(s)] );

Return Value

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

Parameters

Parameter Type Description
Object(s) and/or group(s) Collection of X3DObject and/or Group object(s) Object(s) on which to apply the Unfold Property. The X3DObject must be of type "polymsh".

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

Examples

1. JScript Example

/*
        This example demonstrates how to apply an Unfold property to a simple grid
*/
NewScene(null, false);
var oGrid = CreatePrim("Grid", "MeshSurface");
// Apply the Unfold property to the grid (no computation process are launched)
UnfoldApply(oGrid);

2. Python Example

#
# This example demonstrates how to apply an Unfold property to a group
# consisting of a grid and a sphere
# 
app = Application
app.NewScene("", False)
oGrid = app.CreatePrim("Grid", "MeshSurface")
app.CreatePrim("Sphere", "MeshSurface")
app.Selection.Add(oGrid) # add grid to selection for CreateGroup command
oGroup = app.CreateGroup()
# Apply the Unfold property to the Group (no computation process are launched)
app.UnfoldApply(oGroup)

See Also

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