CIP JAVA documentation for class "com.ptc.pfc.pfcView2D.View2D"

Interface View2D

package com.ptc.pfc.pfcView2D; public interface View2D extends com.ptc.pfc.pfcObject.Child

Description

This interface represents a drawing view in Creo Parametric.

See Also:: Model2D.List2DViews(), Model2D.GetViewByName(String), Selection.GetSelView2D(/*optional*/ View2D)

Direct Known Subclasses:: WView2D

Method Summary
`boolean`	`CheckIsDimensionDisplayed (BaseDimension Dim)`
`void`	`Delete ( /optional/ Boolean DeleteChildren)` Deletes a specified drawing view.
`ViewDisplay`	`GetDisplay ()` Get method for attribute "Display" The drawing view display settings.
`boolean`	`GetIsBackground ()` Get method for attribute "IsBackground"
`boolean`	`GetIsScaleUserdefined ()` Identifies if the drawing view has a user-defined scale.
`boolean`	`GetIsViewdisplayLayerDependent ()` Get method for attribute "IsViewdisplayLayerDependent"
`DisplayStatus`	`GetLayerDisplayStatus (Layer Layer)` Gets the display status of the specified layer in the drawing view.
`Model`	`GetModel ()` Get the model displayed in the drawing view.
`String`	`GetName ()` Get method for attribute "Name" The drawing view name.
`Outline3D`	`GetOutline ()` Get method for attribute "Outline" The outline of the drawing view, in screen coordinates.
`double`	`GetScale ()` Get method for attribute "Scale" The drawing view scale.
`int`	`GetSheetNumber ()` Gets the sheet where the view is located.
`SimpRep`	`GetSimpRep ()` Get the Simplified Representation.
`Transform3D`	`GetTransform ()` Returns the coordinate transformation matrix for the drawing view.
`void`	`Regenerate ()` Regenerates the drawing view.
`void`	`SetDisplay (ViewDisplay value)` Set method for attribute "Display" The drawing view display settings.
`void`	`SetIsViewdisplayLayerDependent (boolean value)` Set method for attribute "IsViewdisplayLayerDependent"
`void`	`SetLayerDisplayStatus (Layer Layer, DisplayStatus Status)` Sets the display status for the layer in the drawing view.
`void`	`SetName (String value)` Set method for attribute "Name" The drawing view name.
`void`	`SetScale (double value)` Set method for attribute "Scale" The drawing view scale.
`void`	`Translate (Vector3D ByVector)` Moves the drawing view by the specified vector.

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Child`
`GetDBParent`, `GetOId`

Method Detail

GetSheetNumber

int GetSheetNumber ()

Gets the sheet where the view is located.

Manual References:: Drawings: Drawing View Information, Drawings: Drawing View Information

Returns:: The sheet number.

GetIsBackground

boolean GetIsBackground ()

Manual References:: Drawings: Drawing View Information, Drawings: Drawing View Information

GetModel

Model GetModel ()

Get the model displayed in the drawing view.

Manual References:: Drawings: Drawing View Information, Drawings: Drawing View Information

Returns:: The model.

GetScale/SetScale

`double`	`GetScale`	`()`
`void`	`SetScale`	`(double value)`

The drawing view scale.

Manual References:: Drawings: Drawing View Information, Drawings: Drawing View Information, Drawings: Drawing Views Operations, Drawings: Drawing Views Operations

GetOutline

Outline3D GetOutline ()

The outline of the drawing view, in screen coordinates.

Manual References:: Drawings: Drawing View Information, Drawings: Drawing View Information

Translate

void Translate (Vector3D ByVector)

Moves the drawing view by the specified vector.

Manual References:: Drawings: Drawing Views Operations, Drawings: Drawing Views Operations

Parameters:

ByVector: The transformation vector.

Returns:

Delete

void Delete ( /*optional*/ Boolean DeleteChildren)

Deletes a specified drawing view.

Manual References:: Drawings: Drawing Views Operations, Drawings: Drawing Views Operations

Parameters:

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

Returns:

Regenerate

void Regenerate ()

Regenerates the drawing view.

Manual References:: Drawings: Drawing Views Operations, Drawings: Drawing Views Operations

Returns:

GetLayerDisplayStatus

DisplayStatus GetLayerDisplayStatus (Layer Layer)

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

Exceptions thrown (but not limited to):

XToolkitNotFound - The specified layer was not found.

Manual References:: Drawings: Drawing View Information, Drawings: Drawing View Information

Parameters:

Layer: The specified layer.

Returns:: The layer display status.

SetLayerDisplayStatus

void SetLayerDisplayStatus (Layer Layer, DisplayStatus Status)

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

Exceptions thrown (but not limited to):

XToolkitNotFound - The specified layer was not found.

XToolkitCantModify - display status of the layer cannot be changed

Manual References:: Drawings: Drawing Views Operations, Drawings: Drawing Views Operations

Parameters:

Layer: The layer.
Status: The display status.

Returns:

GetDisplay/SetDisplay

`ViewDisplay`	`GetDisplay`	`()`
`void`	`SetDisplay`	`(ViewDisplay value)`

The drawing view display settings.

Exceptions thrown (but not limited to):

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

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

Manual References:: Drawings: Drawing View Information, Drawings: Drawing View Information, Drawings: Drawing Views Operations

GetTransform

Transform3D 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.

Manual References:: Drawings: Drawing View Information, Drawings: Drawing View Information

Returns:: The transformation matrix.

GetName/SetName

`String`	`GetName`	`()`
`void`	`SetName`	`(String value)`

The drawing view name.

Exceptions thrown (but not limited to):

XToolkitNotFound - The view did not have a name.

Manual References:: Drawings: Drawing View Information, Drawings: Drawing View Information

GetIsViewdisplayLayerDependent/SetIsViewdisplayLayerDependent

`boolean`	`GetIsViewdisplayLayerDependent`	`()`
`void`	`SetIsViewdisplayLayerDependent`	`(boolean value)`

Manual References:: Drawings: Drawing View Information

GetIsScaleUserdefined

boolean GetIsScaleUserdefined ()

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

Manual References:: Drawings: Drawing View Information, Drawings: Drawing View Information

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

GetSimpRep

SimpRep GetSimpRep ()

Get the Simplified Representation.

Exceptions thrown (but not limited to):

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

Manual References:: Drawings: Drawing View Information

Returns:: The Simplified Representation

CheckIsDimensionDisplayed

boolean CheckIsDimensionDisplayed (BaseDimension Dim)

Parameters:

Dim

Returns: