CIP Visual Basic.NET documentation for interface "IpfcView2D"

Interface IpfcView2D

Description

This interface represents a drawing view in Creo Parametric.

See Also:: IpfcModel2D.List2DViews(), IpfcModel2D.GetViewByName(), IpfcSelection.SelView2D

Direct Parent Classes:: IpfcChild

Property Summary


`Property`	`Display`	`as IpfcViewDisplay`
	The drawing view display settings.

`Property`	`IsBackground`	`as Boolean`


`Property`	`IsViewdisplayLayerDependent`	`as Boolean`


`Property`	`Name`	`as String`
	The drawing view name.

`Property`	`Outline`	`as IpfcOutline3D`
	The outline of the drawing view, in screen coordinates.

`Property`	`Scale`	`as Double`
	The drawing view scale.

Method Summary


`Function`	`CheckIsDimensionDisplayed (Dim as IpfcBaseDimension) as Boolean`


`Sub`	`Delete (DeleteChildren as Boolean [optional])`
	Deletes a specified drawing view.

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

`Function`	`GetLayerDisplayStatus (Layer as IpfcLayer) as IpfcDisplayStatus`
	Gets the display status of the specified layer in the drawing view.

`Function`	`GetModel () as IpfcModel`
	Get the model displayed in the drawing view.

`Function`	`GetSheetNumber () as Long`
	Gets the sheet where the view is located.

`Function`	`GetSimpRep () as IpfcSimpRep`
	Get the Simplified Representation.

`Function`	`GetTransform () as IpfcTransform3D`
	Returns the coordinate transformation matrix for the drawing view.

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

`Sub`	`SetLayerDisplayStatus (Layer as IpfcLayer, Status as IpfcDisplayStatus)`
	Sets the display status for the layer in the drawing view.

`Sub`	`Translate (ByVector as IpfcVector3D)`
	Moves the drawing view by the specified vector.

Property Detail

Property Display as IpfcViewDisplay

The drawing view display settings.

Exceptions thrown (but not limited to):

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

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

Property IsBackground as Boolean

Property IsViewdisplayLayerDependent as Boolean

Property Name as String

The drawing view name.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The view did not have a name.

Property Outline as IpfcOutline3D

The outline of the drawing view, in screen coordinates.

Property Scale as Double

The drawing view scale.

Method Detail

Function CheckIsDimensionDisplayed (Dim as IpfcBaseDimension) as Boolean

Parameters:

Dim

Returns:

Sub Delete (DeleteChildren as Boolean [optional])

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.

Function GetIsScaleUserdefined () as Boolean

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.

Function GetLayerDisplayStatus (Layer as IpfcLayer) as IpfcDisplayStatus

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

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The specified layer was not found.

Parameters:

Layer: The specified layer.

Returns:: The layer display status.

Function GetModel () as IpfcModel

Get the model displayed in the drawing view.

Returns:: The model.

Function GetSheetNumber () as Long

Gets the sheet where the view is located.

Returns:: The sheet number.

Function GetSimpRep () as IpfcSimpRep

Get the Simplified Representation.

Exceptions thrown (but not limited to):

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

Returns:: The Simplified Representation

Function GetTransform () as IpfcTransform3D

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.

Sub Regenerate ()

Regenerates the drawing view.

Sub SetLayerDisplayStatus (Layer as IpfcLayer, Status as IpfcDisplayStatus)

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

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The specified layer was not found.

IpfcXToolkitCantModify - display status of the layer cannot be changed

Parameters:

Layer: The layer.
Status: The display status.

Sub Translate (ByVector as IpfcVector3D)

Moves the drawing view by the specified vector.

Parameters:

ByVector: The transformation vector.