CIP C++ documentation for class "pfcGeneralViewCreateInstructions"

Class pfcGeneralViewCreateInstructions

# include <pfcView2D.h> class pfcGeneralViewCreateInstructions : public virtual pfcView2DCreateInstructions { xdeclare(pfcGeneralViewCreateInstructions) ... }; This is a COMPACT class.

Description

This is the interface used for creating general drawing views.

See Also:: pfcModel2D::CreateView(pfcView2DCreateInstructions_ptr), pfcTransform3D::Create(optional pfcMatrix3D_ptr)

Manual References:: Drawings: Creating Drawing Views

Method Summary


`static pfcGeneralViewCreateInstructions_ptr`	`Create (pfcModel_ptr ViewModel, xint SheetNumber, pfcPoint3D_ptr Location, pfcTransform3D_ptr Orientation)`
	Creates an instructions data object used for creating general drawing views.

`optional xbool`	`GetExploded ()`
`void`	`SetExploded (optional xbool value)`
	`true` if the view should be an exploded view, `null` or `false` otherwise.

`pfcPoint3D_ptr`	`GetLocation ()`
`void`	`SetLocation (pfcPoint3D_ptr value)`
	The location on the sheet where the view should be placed.

`pfcTransform3D_ptr`	`GetOrientation ()`
`void`	`SetOrientation (pfcTransform3D_ptr value)`
	The orientation of the model in the view.

`optional xreal`	`GetScale ()`
`void`	`SetScale (optional xreal value)`
	The scale of the view (`null` to use the default scale).

`xint`	`GetSheetNumber ()`
`void`	`SetSheetNumber (xint value)`
	The sheet number in which to create the view.

`pfcModel_ptr`	`GetViewModel ()`
`void`	`SetViewModel (pfcModel_ptr value)`
	The solid model to display in the view.

`optional xreal`	`GetViewScale ()`
`void`	`SetViewScale (optional xreal value)`
	The scale of the view (`null` to use the default scale).

Methods Inherited from Class pfcView2DCreateInstructions:: GetType

Method Detail

`pfcModel_ptr`	`GetViewModel`	`()`
`void`	`SetViewModel`	`(pfcModel_ptr value)`

The solid model to display in the view.

Manual References:: Drawings: Creating Drawing Views, Drawings: Creating Drawing Views

`xint`	`GetSheetNumber`	`()`
`void`	`SetSheetNumber`	`(xint value)`

The sheet number in which to create the view.

Manual References:: Drawings: Creating Drawing Views, Drawings: Creating Drawing Views

`optional xbool`	`GetExploded`	`()`
`void`	`SetExploded`	`(optional xbool value)`

true if the view should be an exploded view, null or false otherwise.

Manual References:: Drawings: Creating Drawing Views, Drawings: Creating Drawing Views

`pfcPoint3D_ptr`	`GetLocation`	`()`
`void`	`SetLocation`	`(pfcPoint3D_ptr value)`

The location on the sheet where the view should be placed.

Manual References:: Drawings: Creating Drawing Views, Drawings: Creating Drawing Views

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

The scale of the view (null to use the default scale).

Manual References:: Drawings: Creating Drawing Views, Drawings: Creating Drawing Views

`optional xreal`	`GetViewScale`	`()`
`void`	`SetViewScale`	`(optional xreal value)`

The scale of the view (null to use the default scale).

Manual References:: Drawings: Creating Drawing Views, Drawings: Creating Drawing Views, Drawings: Creating Drawing Views

`pfcTransform3D_ptr`	`GetOrientation`	`()`
`void`	`SetOrientation`	`(pfcTransform3D_ptr value)`

The orientation of the model in the view.

The transformation matrix must only consist of the rotation to be applied to the model. It must not consist of any displacement or scale components. If necessary, set the displacement to {0, 0, 0} using pfcTransform3D::SetOrigin(pfcPoint3D_ptr) and remove any scaling factor by normalizing the matrix.

Manual References:: Drawings: Creating Drawing Views, Drawings: Creating Drawing Views

static pfcGeneralViewCreateInstructions_ptr Create (pfcModel_ptr ViewModel, xint SheetNumber, pfcPoint3D_ptr Location, pfcTransform3D_ptr Orientation)

Creates an instructions data object used for creating general drawing views.

See Also:: pfcModel2D::CreateView(pfcView2DCreateInstructions_ptr), pfcTransform3D::Create(optional pfcMatrix3D_ptr)

Manual References:: Drawings: Creating Drawing Views, Drawings: Creating Drawing Views

Parameters:

ViewModel: The solid model to display in the view.
SheetNumber: The sheet number in which to create the view.
Location: The location on the sheet where the view should be placed.
Orientation: The orientation of the model in the view.

Returns:: The created data object.