CIP C++ documentation for class "pfcView2D"

Class pfcView2D

# include <pfcView2D.h> class pfcView2D : public virtual pfcChild { xaideclare(pfcView2D) ... };

Description

This interface represents a drawing view in Creo Parametric.

See Also:: pfcModel2D::List2DViews(), pfcModel2D::GetViewByName(xrstring), pfcSelection::GetSelView2D(optional pfcView2D_ptr)

Direct Known Subclasses:: wfcWView2D

Method Summary


`xbool`	`CheckIsDimensionDisplayed (pfcBaseDimension_ptr Dim)`


`void`	`Delete (optional xbool DeleteChildren)`
	Deletes a specified drawing view.

`pfcViewDisplay_ptr`	`GetDisplay ()`
`void`	`SetDisplay (pfcViewDisplay_ptr value)`
	The drawing view display settings.

`xbool`	`GetIsBackground ()`


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

`xbool`	`GetIsViewdisplayLayerDependent ()`
`void`	`SetIsViewdisplayLayerDependent (xbool value)`


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

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

`xstring`	`GetName ()`
`void`	`SetName (xrstring value)`
	The drawing view name.

`pfcOutline3D_ptr`	`GetOutline ()`
	The outline of the drawing view, in screen coordinates.

`xreal`	`GetScale ()`
`void`	`SetScale (xreal value)`
	The drawing view scale.

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

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

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

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





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





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

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Method Detail

xint GetSheetNumber ()

Gets the sheet where the view is located.

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

Returns:: The sheet number.

xbool GetIsBackground ()

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

pfcModel_ptr GetModel ()

Get the model displayed in the drawing view.

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

Returns:: The model.

`xreal`	`GetScale`	`()`
`void`	`SetScale`	`(xreal value)`

The drawing view scale.

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

pfcOutline3D_ptr GetOutline ()

The outline of the drawing view, in screen coordinates.

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

void Translate (pfcVector3D_ptr 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:

void Delete (optional xbool 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:

void Regenerate ()

Regenerates the drawing view.

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

Returns:

pfcDisplayStatus GetLayerDisplayStatus (pfcLayer_ptr 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.

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

Parameters:

Layer: The specified layer.

Returns:: The layer display status.

void SetLayerDisplayStatus (pfcLayer_ptr 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

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

Parameters:

Layer: The layer.
Status: The display status.

Returns:

`pfcViewDisplay_ptr`	`GetDisplay`	`()`
`void`	`SetDisplay`	`(pfcViewDisplay_ptr value)`

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.

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

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

`xstring`	`GetName`	`()`
`void`	`SetName`	`(xrstring value)`

The drawing view name.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The view did not have a name.

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

`xbool`	`GetIsViewdisplayLayerDependent`	`()`
`void`	`SetIsViewdisplayLayerDependent`	`(xbool value)`

Manual References:: Drawings: Drawing View Information

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

pfcSimpRep_ptr GetSimpRep ()

Get the Simplified Representation.

Exceptions thrown (but not limited to):

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

Manual References:: Drawings: Drawing View Information

Returns:: The Simplified Representation

xbool CheckIsDimensionDisplayed (pfcBaseDimension_ptr Dim)

Parameters:

Dim

Returns: