API Documentation > Interface Classes > Class wfcWModel2D
Class wfcWModel2D

# include <wfcModel.h>

class
wfcWModel2D
: public virtual
wfcWModel,
: public virtual
pfcModel2D
{
xaideclare(wfcWModel2D)
...
};


Description
Direct Known Subclasses:
Methods Inherited from Class pfcActionSource::
Methods Inherited from Class pfcParent::
Methods Inherited from Class pfcParameterOwner::
Methods Inherited from Class wfcWParameterOwner::
Methods Inherited from Class pfcRelationOwner::
Methods Inherited from Class wfcWRelationOwner::
Methods Inherited from Class pfcModelItemOwner::
Methods Inherited from Class pfcViewOwner::
Methods Inherited from Class pfcChild::
Methods Inherited from Class pfcModel::
Methods Inherited from Class wfcWModel::
Methods Inherited from Class pfcSheetOwner::
Methods Inherited from Class pfcDetailItemOwner::
Methods Inherited from Class pfcTableOwner::
Methods Inherited from Class pfcModel2D::
Method Summary
void
CollapseTree (xint WindowId)
Collapse the tree for the drawing.
Create a copy of a drawing sheet.
LICENSE: 222
void
ExpandTree (xint WindowId)
Expand the tree for the drawing.
Outputs the location grid column for a specified location in screen coordinates.
Outputs the location grid row for a specified location in screen coordinates.
Get the assigned tolerance standard of a drawing.
Checks if the sheet format is blanked.
void
RefreshTree (xint WindowId)
Refresh the tree for the drawing.
void
void
Set the assigned tolerance standard of a drawing.
void
ShowSheetFormat (xbool Show, xint Sheet)
Method Detail
void
SetFormatSize
(wfcFormatSizeData_ptr Data, xint Sheet)
User Guide References:
Parameters:
Data
Sheet
Returns:
GetFormatSize
(xint Sheet)
User Guide References:
Parameters:
Sheet
Returns:
void
ShowSheetFormat
(xbool Show, xint Sheet)
User Guide References:
Parameters:
Show
Sheet
Returns:
IsSheetFormatShown
(xint Sheet)
User Guide References:
Parameters:
Sheet
Returns:
IsSheetFormatBlanked
(xint Sheet)
Checks if the sheet format is blanked.
User Guide References:
Parameters:
Sheet
The sheet number. Set this to a value less than 1 for the current sheet.
Returns:
Boolean indicating whether the sheet is blanked or not.
void
SetToleranceStandard
(wfcIndustryStandard Standard)
Set the assigned tolerance standard of a drawing.
in the regular UI, this operation asks whether to regenerate the drawing. This function will not itself perform regeneration.
User Guide References:
Parameters:
Standard
The tolerance standard to set.
Returns:
GetToleranceStandard
()
Get the assigned tolerance standard of a drawing.
User Guide References:
Returns:
The tolerance standard.
void
ExpandTree
(xint WindowId)
Expand the tree for the drawing.
Exceptions thrown (but not limited to):
pfcXToolkitNoChange - There is no change in the drawing tree
User Guide References:
Parameters:
WindowId
Id of the window which contains the drawing. Use -1 to expand the drawing tree in the active window.
Returns:
void
CollapseTree
(xint WindowId)
Collapse the tree for the drawing.
Exceptions thrown (but not limited to):
pfcXToolkitNoChange - There is no change in the drawing tree.
User Guide References:
Parameters:
WindowId
Id of the window which contains the drawing. Use -1 to collapse the drawing tree in the active window.
Returns:
void
RefreshTree
(xint WindowId)
Refresh the tree for the drawing.
Exceptions thrown (but not limited to):
pfcXToolkitNoChange - There is no change in the drawing tree
User Guide References:
Parameters:
WindowId
Id of the window which contains the drawing. Use -1 to refresh the drawing tree in the active window.
Returns:
CopyDrawingSheet
(xint Sheet)
Create a copy of a drawing sheet.
Exceptions thrown (but not limited to):
pfcXToolkitInvalidType - Invalid model type specified.
pfcXToolkitCantModify - Drawing can't be modified.
pfcXToolkitCantWrite - Drawing sheet copy attempt failed.
User Guide References:
Parameters:
Sheet
The sheet number of the sheet to create a copy of. Set this to a value less than 1 for the current sheet.
Returns:
The sheet number of the copy.
GetLocationGridColumnFromPosition
(pfcPoint3D_ptr Position, xint Sheet)
Outputs the location grid column for a specified location in screen coordinates.
Exceptions thrown (but not limited to):
pfcXToolkitNotExist - No location grid is defined on the specified sheet
pfcXToolkitOutOfRange - 'Position' is outside of the location grid
User Guide References:
Parameters:
Position
The location in screen coordinates.
Sheet
The sheet number. If not provided, the current sheet will be used.
Returns:
The label on the corresponding location grid column.
GetLocationGridRowFromPosition
(pfcPoint3D_ptr Position, xint Sheet)
Outputs the location grid row for a specified location in screen coordinates.
Exceptions thrown (but not limited to):
pfcXToolkitNotExist - No location grid is defined on the specified sheet
pfcXToolkitOutOfRange - 'Position' is outside of the location grid
User Guide References:
Parameters:
Position
The location in screen coordinates.
Sheet
The sheet number. If not provided, the current sheet will be used.
Returns:
The label on the corresponding location grid row.
CreateLeaderWithArrowTypeNote
LICENSE: 222
Exceptions thrown (but not limited to):
pfcXToolkitOutOfMemory - Not enough memory.
User Guide References:
Parameters:
TextLines
NoteAttach
LeaderAttachs
Types
Returns:
Was this helpful?