CIP JavaScript documentation for class " pfcView2D"

Class pfcView2D

Description

This interface represents a drawing view in Creo Parametric.

See Also:: pfcModel2D.List2DViews(), pfcModel2D.GetViewByName(), pfcSelection.SelView2D

Direct Parent Classes:: pfcChild

Property Summary


`pfcViewDisplay`	`Display`
	The drawing view display settings.

`/* readonly */ boolean`	`IsBackground`


`boolean`	`IsViewdisplayLayerDependent`


`string`	`Name`
	The drawing view name.

`/* readonly */ pfcOutline3D`	`Outline`
	The outline of the drawing view, in screen coordinates.

`number`	`Scale`
	The drawing view scale.

Method Summary


`boolean`	`CheckIsDimensionDisplayed (pfcBaseDimension Dim)`


`void`	`Delete ( /* optional */ boolean DeleteChildren)`
	Deletes a specified drawing view.

`boolean`	`GetIsScaleUserdefined ()`
	Identifies if the drawing view has a user-defined scale.

`pfcDisplayStatus`	`GetLayerDisplayStatus (pfcLayer Layer)`
	Gets the display status of the specified layer in the drawing view.

`pfcModel`	`GetModel ()`
	Get the model displayed in the drawing view.

`number`	`GetSheetNumber ()`
	Gets the sheet where the view is located.

`pfcSimpRep`	`GetSimpRep ()`
	Get the Simplified Representation.

`pfcTransform3D`	`GetTransform ()`
	Returns the coordinate transformation matrix for the drawing view.

`void`	`Regenerate ()`
	Regenerates the drawing view.

`void`	`SetLayerDisplayStatus (pfcLayer Layer, pfcDisplayStatus Status)`
	Sets the display status for the layer in the drawing view.

`void`	`Translate (pfcVector3D ByVector)`
	Moves the drawing view by the specified vector.

Property Detail

pfcViewDisplay Display

The drawing view display settings.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The drawing view is a child of another view and inherits its display from its parent.

pfcXToolkitNoLicense - The function attempted to set the concept_model field, but no Pro/ASSEMBLY license is available.

/* readonly */ boolean IsBackground

boolean IsViewdisplayLayerDependent

string Name

The drawing view name.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The view did not have a name.

/* readonly */ pfcOutline3D Outline

The outline of the drawing view, in screen coordinates.

number Scale

The drawing view scale.

Method Detail

boolean CheckIsDimensionDisplayed (pfcBaseDimension Dim)

Parameters:

Dim

Returns:

void Delete ( /* optional */ boolean DeleteChildren)

Deletes a specified drawing view.

Parameters:

DeleteChildren: true to delete the children of the view, false or null to prevent deletion of the view if it has children.

boolean GetIsScaleUserdefined ()

Identifies if the drawing view has a user-defined scale.

Returns:: true if the view scale is user-defined, false if it uses the default scale for this sheet and model.

pfcDisplayStatus GetLayerDisplayStatus (pfcLayer Layer)

Gets the display status of the specified layer in the drawing view.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The specified layer was not found.

Parameters:

Layer: The specified layer.

Returns:: The layer display status.

pfcModel GetModel ()

Get the model displayed in the drawing view.

Returns:: The model.

number GetSheetNumber ()

Gets the sheet where the view is located.

Returns:: The sheet number.

pfcSimpRep GetSimpRep ()

Get the Simplified Representation.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidType - The top model for the view is not a solid.

Returns:: The Simplified Representation

pfcTransform3D GetTransform ()

Returns the coordinate transformation matrix for the drawing view.

The transformation matrix is a combination of the following factors:

The location of the view origin with respect to the drawing origin.
The scale of the view units with respect to the drawing units.
The rotation of the model with respect to the drawing coordinate system.

Returns:: The transformation matrix.

void Regenerate ()

Regenerates the drawing view.

void SetLayerDisplayStatus (pfcLayer Layer, pfcDisplayStatus Status)

Sets the display status for the layer in the drawing view.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The specified layer was not found.

pfcXToolkitCantModify - display status of the layer cannot be changed

Parameters:

Layer: The layer.
Status: The display status.

void Translate (pfcVector3D ByVector)

Moves the drawing view by the specified vector.

Parameters:

ByVector: The transformation vector.