CIP JavaScript documentation for class " pfcRegenInstructions"

Class pfcRegenInstructions

Description

This class describes the instructions for regenerating the solid.

Property Summary


`boolean`	`AllowFixUI`
	If this is `true`, the Fix Model interface is displayed if there is an error.

`boolean`	`ForceRegen`
	Forces the solid to fully regenerate. This will regenerate every feature in the solid. If not set, Creo Parametric uses its internal algorithm to determine which features to regenerate.

`/* optional */ pfcFeature`	`FromFeat`
	Not used. Reserved for the future.

`boolean`	`RefreshModelTree`
	If this is `true`, refresh the Creo Parametric Model Tree after the regeneration. If this is `false` (the default) the tree is not refreshed. A model must be active to use this attribute.

`boolean`	`ResolveModeRegen`
	Regenerate in resolve mode

`boolean`	`ResumeExcludedComponents`
	Enables Creo Parametric to resume available excluded components of the simplified representation during regeneration. This can result in a more accurate update of the simplified representation.

`boolean`	`UpdateAssemblyOnly`
	Updates assembly and sub-assembly placements and regenerates assembly features and intersected parts. If the affected assembly is retrieved as a simplified representation, this flag will update the locations of the components.If the flag is not set, the component locations are not updated by default when the simplified representation is retrieved.

`boolean`	`UpdateInstances`
	Updates instances of the solid in memory. This may slow down the regeneration process.

Method Summary


`static pfcRegenInstructions`	`Create ( /* optional / boolean AllowFixUI, / optional / boolean ForceRegen, / optional */ pfcFeature FromFeat)`
	Creates a new RegenInstructions object.

Property Detail

boolean AllowFixUI

If this is true, the Fix Model interface is displayed if there is an error.

boolean ForceRegen

Forces the solid to fully regenerate. This will regenerate every feature in the solid. If not set, Creo Parametric uses its internal algorithm to determine which features to regenerate.

/* optional */ pfcFeature FromFeat

Not used. Reserved for the future.

boolean RefreshModelTree

If this is true, refresh the Creo Parametric Model Tree after the regeneration. If this is false (the default) the tree is not refreshed. A model must be active to use this attribute.

boolean ResolveModeRegen

Regenerate in resolve mode

Allows temporary override of default settings controlling regeneration behavior.

boolean ResumeExcludedComponents

Enables Creo Parametric to resume available excluded components of the simplified representation during regeneration. This can result in a more accurate update of the simplified representation.

boolean UpdateAssemblyOnly

Updates assembly and sub-assembly placements and regenerates assembly features and intersected parts. If the affected assembly is retrieved as a simplified representation, this flag will update the locations of the components.If the flag is not set, the component locations are not updated by default when the simplified representation is retrieved.

boolean UpdateInstances

Updates instances of the solid in memory. This may slow down the regeneration process.

Method Detail

static pfcRegenInstructions Create ( /* optional */ boolean AllowFixUI, /* optional */ boolean ForceRegen, /* optional */ pfcFeature FromFeat)

Creates a new RegenInstructions object.

Parameters:

AllowFixUI: If this is true, the Fix Model interface is displayed if there is an error. If this is false, the Fix Model interface is not displayed. (If null is passed, false is assumed.)
ForceRegen: Reserved for the future. Pass null.
FromFeat: Reserved for the future. Pass null.

Returns:: The new RegenInstructions object