CIP JavaScript documentation for class " pfcGeneralViewCreateInstructions"

Class pfcGeneralViewCreateInstructions

Description

This is the interface used for creating general drawing views.

See Also:: pfcModel2D.CreateView(), pfcTransform3D.Create()

Direct Parent Classes:: pfcView2DCreateInstructions

Property Summary


`/* optional */ boolean`	`Exploded`
	`true` if the view should be an exploded view, `null` or `false` otherwise.

`pfcPoint3D`	`Location`
	The location on the sheet where the view should be placed.

`pfcTransform3D`	`Orientation`
	The orientation of the model in the view.

`/* optional */ number`	`Scale`
	The scale of the view (`null` to use the default scale).

`number`	`SheetNumber`
	The sheet number in which to create the view.

`pfcModel`	`ViewModel`
	The solid model to display in the view.

`/* optional */ number`	`ViewScale`
	The scale of the view (`null` to use the default scale).

Method Summary


`static pfcGeneralViewCreateInstructions`	`Create (pfcModel ViewModel, number SheetNumber, pfcPoint3D Location, pfcTransform3D Orientation)`
	Creates an instructions data object used for creating general drawing views.

Property Detail

/* optional */ boolean Exploded

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

pfcPoint3D Location

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

pfcTransform3D Orientation

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() and remove any scaling factor by normalizing the matrix.

/* optional */ number Scale

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

number SheetNumber

The sheet number in which to create the view.

pfcModel ViewModel

The solid model to display in the view.

/* optional */ number ViewScale

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

Method Detail

static pfcGeneralViewCreateInstructions Create (pfcModel ViewModel, number SheetNumber, pfcPoint3D Location, pfcTransform3D Orientation)

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

See Also:: pfcModel2D.CreateView(), pfcTransform3D.Create()

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.