CIP JavaScript documentation for class " pfcModel2D"

Class pfcModel2D

Description

This interface represents a two-dimensional Creo Parametric model.

See Also:: pfcBaseSession.ListModels(), pfcBaseSession.GetModel(), pfcBaseSession.GetModelFromDescr(), pfcBaseSession.CreateDrawingFromTemplate(), pfcBaseSession.Import2DModel(), pfcDrawing, pfcReport, pfcLayout

Direct Parent Classes:: pfcSheetOwner, pfcDetailItemOwner, pfcTableOwner, pfcModel

Direct Known Subclasses:: pfcDrawing, pfcReport, pfcLayout

Property Summary


`number`	`TextHeight`
	The text height of the model. The model must be in the current window inorderto access this property.

Method Summary


`void`	`AddModel (pfcModel NewModel)`
	Adds a solid model to the drawing.

`void`	`AddSimplifiedRep (pfcSimpRep SimplifiedRep)`
	Adds a new simplified representation of a model to a drawing.

`/* optional */ pfcDimensions`	`CollectShownDimensions (pfcSolid SolidMdl)`


`/* optional */ pfcDimensions`	`CollectShownRefDimensions (pfcSolid SolidMdl)`


`pfcDimension`	`CreateDimension (pfcDimensionAttachments Attachments, pfcDimSenses Senses, pfcDimOrientationHint hint, pfcPoint2D Location)`


`pfcDimension2D`	`CreateDrawingDimension (pfcDrawingDimCreateInstructions Instructions)`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): Model2D.CreateRefDimension, Model2D.CreateDimension`
Creates a new drawing dimension.

`pfcDimension`	`CreateRefDimension (pfcDimensionAttachments Attachments, pfcDimSenses Senses, pfcDimOrientationHint hint, pfcPoint2D Location)`


`pfcView2D`	`CreateView (pfcView2DCreateInstructions Instructions)`
	Creates a new view in the drawing.

`void`	`DeleteModel (pfcModel Model)`
	Removes a model from the drawing.

`void`	`DeleteSimplifiedRep (pfcSimpRep SimplifiedRep)`
	Deletes a simplified representation of a model from a drawing.

`/* optional */ pfcModel`	`GetCurrentSolid ()`
	Gets the current solid model of the drawing

`/* optional */ pfcView2D`	`GetViewByName (string ViewName)`
	Returns a drawing view, given its name.

`/* optional */ pfcView2D`	`GetViewDisplaying (pfcBaseDimension Dim)`
	Returns the drawing view that displays a dimension.

`pfcView2Ds`	`List2DViews ()`
	Lists the drawing views.

`/* optional */ pfcModels`	`ListModels ()`
	Lists the models used in the drawing.

`pfcDimension2Ds`	`ListShownDimensions (pfcModel Model, /* optional */ pfcModelItemType Type)`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): Model2D.CollectShownRefDimensions, Model2D.CollectShownDimensions`
Lists the solid-model owned dimensions and reference dimensions shown in the drawing.

`/* optional */ pfcSimpReps`	`ListSimplifiedReps (pfcModel Solid)`
	Returns a list of the simplified representations referenced by the drawing.

`void`	`Regenerate ()`
	Regenerates the drawing draft entities.

`void`	`ReplaceModel (pfcModel FromModel, pfcModel ToModel, boolean Unrepresent)`
	Replaces a drawing model solid with another solid. The old and new solids must be members of the same family table.

`void`	`SetCurrentSolid (pfcModel NewCurrentSolid)`
	Sets the current solid model for the drawing.

`void`	`SetViewDisplaying (pfcBaseDimension Dim, pfcView2D NewView)`
	Sets the view that shows the model dimension.

Property Detail

number TextHeight

The text height of the model. The model must be in the current window inorderto access this property.

Method Detail

void AddModel (pfcModel NewModel)

Adds a solid model to the drawing.

Exceptions thrown (but not limited to):

pfcXToolkitInUse - The function did nothing because the specified model already exists.

Parameters:

NewModel: The model to add.

void AddSimplifiedRep (pfcSimpRep SimplifiedRep)

Adds a new simplified representation of a model to a drawing.

Allows the creation of views displaying the simplified rep.

Exceptions thrown (but not limited to):

pfcXToolkitFound - The function did nothing because the specified simplified representation already exists.

See Also:: pfcModel2D.AddModel(), pfcModel2D.ListSimplifiedReps(), pfcModel2D.ListModels(), pfcModel2D.DeleteSimplifiedRep(), pfcModel2D.DeleteModel()

Parameters:

SimplifiedRep: The simplfied representation to add to the drawing.

/* optional */ pfcDimensions CollectShownDimensions (pfcSolid SolidMdl)

Exceptions thrown (but not limited to):

pfcXToolkitNoLicense - License check failure.

pfcXToolkitNotFound - No model dimensions were visited.

Parameters:

SolidMdl

Returns:

/* optional */ pfcDimensions CollectShownRefDimensions (pfcSolid SolidMdl)

Exceptions thrown (but not limited to):

pfcXToolkitNoLicense - License check failure.

pfcXToolkitNotFound - No model dimensions were visited.

Parameters:

SolidMdl

Returns:

pfcDimension CreateDimension (pfcDimensionAttachments Attachments, pfcDimSenses Senses, pfcDimOrientationHint hint, pfcPoint2D Location)

Exceptions thrown (but not limited to):

pfcXToolkitBadDimAttach - a dimension could not be created with the attachments and sense specified.

Parameters:

Attachments
Senses
hint
Location

Returns:

pfcDimension2D CreateDrawingDimension (pfcDrawingDimCreateInstructions Instructions)


`DEPRECATED: since Creo 4`
`SUCCESSOR(S): Model2D.CreateRefDimension, Model2D.CreateDimension`
Creates a new drawing dimension. Exceptions thrown (but not limited to): `pfcXToolkitBadDimAttach` - a dimension could not be created with the attachments and sense specified. Parameters: `Instructions` Data object containing information needed to place the dimension. Returns: The created dimension.

pfcDimension CreateRefDimension (pfcDimensionAttachments Attachments, pfcDimSenses Senses, pfcDimOrientationHint hint, pfcPoint2D Location)

Exceptions thrown (but not limited to):

pfcXToolkitBadDimAttach - a dimension could not be created with the attachments and sense specified.

Parameters:

Attachments
Senses
hint
Location

Returns:

pfcView2D CreateView (pfcView2DCreateInstructions Instructions)

Creates a new view in the drawing.

Before calling this method, display the drawing using the pfcModel.Display() method.

Exceptions thrown (but not limited to):

pfcXToolkitCreateViewBadSheet - The specified sheet does not exist.

pfcXToolkitCreateViewBadModel - The specified model is not in the list of drawing models, or the function cannot make the specified view of this model.

pfcXToolkitCreateViewBadExplode - The function cannot explode the view model.

pfcXToolkitCreateViewBadParent - The parent view for project does not exist, or is of unsupported type, or does not align with the selected position.

See Also:: pfcGeneralViewCreateInstructions, pfcProjectionViewCreateInstructions

Parameters:

Instructions: Data object containing details about how to create the view.

Returns:: The newly created drawing view.

void DeleteModel (pfcModel Model)

Removes a model from the drawing.

The model cannot appear in any drawing views.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The function did nothing because the model is NULL.

pfcXToolkitNotFound - The function failed because the specified model is not in the drawing.

pfcXToolkitInUse - The function failed because the specified model is referenced by a view.

Parameters:

Model: The model to remove.

void DeleteSimplifiedRep (pfcSimpRep SimplifiedRep)

Deletes a simplified representation of a model from a drawing.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The function did nothing because the simplified representation is null.

pfcXToolkitNotFound - The function failed because the specified simplified representation is not in the drawing.

pfcXToolkitInUse - The function failed because the specified model and simplified representation are referenced by another view in the drawing.

See Also:: pfcModel2D.DeleteModel(), pfcModel2D.ListSimplifiedReps(), pfcModel2D.ListModels(), pfcModel2D.AddSimplifiedRep(), pfcModel2D.AddModel()

Parameters:

SimplifiedRep: The simplfied representation to delete from the drawing.

/* optional */ pfcModel GetCurrentSolid ()

Gets the current solid model of the drawing

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - No current model is assigned to the drawing.

Returns:: The current solid model.

/* optional */ pfcView2D GetViewByName (string ViewName)

Returns a drawing view, given its name.

Parameters:

ViewName: The name of the drawing view.

Returns:: The drawing view, or null, if the view does not exist.

/* optional */ pfcView2D GetViewDisplaying (pfcBaseDimension Dim)

Returns the drawing view that displays a dimension.

Works for solid and drawing dimensions.

Exceptions thrown (but not limited to):

pfcXToolkitNotDisplayed - The dimension is not displayed in the drawing.

Parameters:

Dim: The dimension object.

Returns:: The view where the dimension is displayed, or null, if the dimension is not displayed in the drawing.

pfcView2Ds List2DViews ()

Lists the drawing views.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - No views were found

Returns:: The drawing views found. This does not include the drawing sheet background view(s), returned by pfcSheetOwner.GetSheetBackgroundView().

/* optional */ pfcModels ListModels ()

Lists the models used in the drawing.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - No drawing models were found

Returns:: Sequence of models used in the drawing, or null, if no models are used.

pfcDimension2Ds ListShownDimensions (pfcModel Model, /* optional */ pfcModelItemType Type)


`DEPRECATED: since Creo 4`
`SUCCESSOR(S): Model2D.CollectShownRefDimensions, Model2D.CollectShownDimensions`
Lists the solid-model owned dimensions and reference dimensions shown in the drawing. Exceptions thrown (but not limited to): `pfcXToolkitNotFound` - No model dimensions were visited. Parameters: `Model` The model which owns the dimensions. `Type` The type of dimension to find, or `null` to find normal and reference dimensions. Returns: The list of dimensions and reference dimensions.

/* optional */ pfcSimpReps ListSimplifiedReps (pfcModel Solid)

Returns a list of the simplified representations referenced by the drawing.

See Also:: pfcModel2D.ListModels(), pfcModel2D.AddSimplifiedRep(), pfcModel2D.AddModel(), pfcModel2D.DeleteSimplifiedRep(), pfcModel2D.DeleteModel()

Parameters:

Solid: The solid model owner of the simplified representations.

Returns:: Sequence of simplified representations found, or null, if no representations were found.

void Regenerate ()

Regenerates the drawing draft entities.

If the model is a layout, this regenerates the layout and its relations.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidType - Model is not a notebook

void ReplaceModel (pfcModel FromModel, pfcModel ToModel, boolean Unrepresent)

Replaces a drawing model solid with another solid. The old and new solids must be members of the same family table.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The 'from' model is not in the drawing.

pfcXToolkitFound - The 'to' model is already in the drawing.

pfcXToolkitBadContext - unrepresent_ok was FALSE, but the "from" solid had a simplified view. OR 'from' and 'to' solids were not from the same family table.

See Also:: pfcModel2D.AddModel(), pfcModel2D.ListModels(), pfcModel2D.DeleteModel()

Parameters:

FromModel: The model to be replaced.
ToModel: The model to use as the replacement.
Unrepresent: true to unrepresent any simplified views of the old model in the drawing, false to fail if the old model has one or more simplified views in the drawing.

void SetCurrentSolid (pfcModel NewCurrentSolid)

Sets the current solid model for the drawing.

Before calling this method, the solid model must be assigned to the drawing using pfcModel2D.AddModel(). To see changes to parameters and fields reflecting the change of the current solid model, regenerate the drawing using pfcSheetOwner.RegenerateSheet()

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The solid is not included in the drawing.

Parameters:

NewCurrentSolid: The solid model to be made current.

void SetViewDisplaying (pfcBaseDimension Dim, pfcView2D NewView)

Sets the view that shows the model dimension.

Before calling this method, dimension should be displayed in the drawing.

Exceptions thrown (but not limited to):

pfcXToolkitCantWrite - Could not delete the given item because it has read-only access.

Parameters:

Dim: The model dimension.
NewView: The view in which to show this dimension.