Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

DraftingUseItf Interface CATIDftSheet

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIDftSheet

Interface of the Sheet object.
Role: The Sheet aggregates view objects

Method Index

o AddView(CATIDftView*,double[2])
o CreateDetailView(double*,CATUnicodeString,CATIDftView**): Create a detail view in the detail sheet .
o CreateView(double*,CATMathPlane,CATDftViewType,CATUnicodeString,CATIDftView**): Create a view in the Sheet.
o GenerateDimensions(CATBoolean)
o GetBackgroundView(CATIDftView**): Gets the background view in the sheet.
o GetDefaultActiveView(CATIDftView**): Gets the view which have to be activated in the sheet.
o GetDrawing(CATIDftDrawing**): Gets the drawing containing this sheet.
o GetFramePoints(double&,double&,double&,double&)
o GetGenViewsPosMode(CATDftGenViewsPosMode&): Gets the stability mode for the position of generative views inside the sheet.
o GetMainView(CATIDftView**): Gets the main view in the sheet.
o GetProjectionMethod(CATDftProjectionMethod*): Gets the projection method in this sheet.
o GetScale(double*): Gets the global scale associated to the sheet.
o GetViews(CATIUnknownList**): Returns the view referenced by the sheet.
o IsCurrent(CATBoolean*): This method is used to know if the sheet is the current one in the drawing.
o IsDetail(boolean*): Used to know if a sheet can be used to as a detail sheet.
o ReorderViews(CATIUnknownList*): Change the positions of the views in a sheet according to the given ordered list.
o SetDefaultActiveView(CATIDftView*): Sets the view which have to be activated in the sheet.
o SetGenViewsPosMode(CATDftGenViewsPosMode): Changes the stability mode for the position of generative views inside the sheet.
o SetPrintArea(double*): Sets a set of coordinates to define a rectangle print area.
o SetPrintAreaActivationState(boolean): Activates or deactivates the print area.
o SetProjectionMethod(CATDftProjectionMethod): Sets the projection method in this sheet.
o SetScale(double): Sets the global scale associated to the sheet.
o ValidateViewOrder(CATIUnknownList*): Validates that the given ordered list can be used as an input for ReorderViews.

Methods

o AddView

public virtual AddView(	const	`iView`,
		`iPosition`)

Deprecated:

R417 Adds a view in the sheet.

Parameters:

const: CATIDftView *iView The view to be added.
const: double iPosition[2] The view position in the sheet.

o CreateDetailView

public virtual CreateDetailView(		`iPtOrigin`,
		`iViewName`,
		`opiDftView`)

Create a detail view in the detail sheet .
Role: The detail view is a reference component.

Parameters:

iPtOrigin: [in] Origin of the detail view.
iViewName: [in] Name of the view. (If iViewName is empty, the view name will calculated automaticaly).
opiDftView: [out, CATBaseUnknown#Release] The view.

Returns:

a HRESULT

S_OK: Success.
E_FAIL: Failure. The sheet is not a detail sheet.

o CreateView

public virtual CreateView(		`iPtOrigin`,
		`iPlane`,
		`iViewType`,
		`iViewName`,
		`opiDftView`)

Create a view in the Sheet.
Role: The created view is aggregated by the sheet.

Parameters:

iPtOrigin: [in] Origin of the view.
iPlane: [in] Projection plane definition of the view.
iViewType: [in] View type
iViewName: [in] Name of the view. (If iViewName is empty, the view name will calculated automaticaly).
opiDftView: [out, CATBaseUnknown#Release] The view.

Returns:

a HRESULT

S_OK: Success.
E_INVALIDARG: Type of the view is incorrect.
E_FAIL: Failure. The Sheet is a detail sheet: Use CreateDetailView to create a detail view in a detail sheet.

o GenerateDimensions

public virtual GenerateDimensions( iOnlyAssyCst = TRUE)

Deprecated:

R417 Generates dimensions in the sheet, from constraints contained in 3d representation represented in generative views.
Warning: This method is not available with 2D Layout for 3D Design.

Parameters:

CATBoolean

iOnlyAssyCst [in] the mode for generation.

TRUE: only constraints contained in assemblies are taken into account when generating dimensions.
FALSE: constraints contained in assemblies and constraints contained in representations are taken into account when generating dimensions.

Returns:

a HRESULT

S_OK: Success.
S_FALSE: Success. But there is no generative views in the sheet.
E_FAIL: Failure.

o GetBackgroundView

public virtual GetBackgroundView( oView)

Gets the background view in the sheet. The background view contains the frame and title-blocks.

Parameters:

CATIDftView: **oView The background view in the sheet.

o GetDefaultActiveView

public virtual GetDefaultActiveView( oView)

Gets the view which have to be activated in the sheet. By default, the active view is the view in edition.

Parameters:

CATIDftView: **oView The default active view in the sheet.

o GetDrawing

public virtual GetDrawing( oDrawing)

Gets the drawing containing this sheet.

Parameters:

CATIDftDrawing: **oDrawing The father drawing.

o GetFramePoints

public virtual GetFramePoints(		`oBLx`,
		`oBLy`,
		`oTRx`,
		`oTRy`)

Deprecated:

R417 Gets the coordinates of the sheet frame. The sheet frame is the graphical representation of the sheet format (A0, A1, ...)..
Warning: This method is not available with 2D Layout for 3D Design.

Parameters:

oBLx: The bottom left x coordinate
oBLy: The bottom left y coordinate
oTRx: The top right x coordinate
oTRy: The top right y coordinate

o GetGenViewsPosMode

public virtual GetGenViewsPosMode( oPosMode)

Gets the stability mode for the position of generative views inside the sheet.
Warning: This method is not available with 2D Layout for 3D Design.

See also:

Parameters:

CATDftGenViewsPosMode: &oPosMode [out] the stability mode.

Returns:

Un HRESULT

S_OK: Success.
E_FAIL: Failure.

o GetMainView

public virtual GetMainView( oView)

Gets the main view in the sheet. The main view contains geometry associated to the sheet.

Parameters:

CATIDftView: **oView The main view in the sheet.

o GetProjectionMethod

public virtual GetProjectionMethod( oProjMethod)

Gets the projection method in this sheet.

Parameters:

CATDftProjectionMethod: *oProjMethod The projection method: - CATFirstAngle: First angle standard. - CATThirdAngle: Third angle standard.

o GetScale

public virtual GetScale( oScale)

Gets the global scale associated to the sheet. This scale is applied on the sheet views.

Parameters:

double: *oScale The global scale of the sheet

o GetViews

public virtual GetViews( oLstResult)

Returns the view referenced by the sheet.

Parameters:

CATIUnknownList: *oLstResult Founded views are added to the list.

o IsCurrent

public virtual IsCurrent( oSheetStatus)

This method is used to know if the sheet is the current one in the drawing. The current sheet is the sheet containing the view in edition.

Returns:

The status
Legal values:

0
1

o IsDetail

public virtual IsDetail( oDetSheet)

Used to know if a sheet can be used to as a detail sheet.

Parameters:

boolean: *oDetSheet TRUE if it is a detail sheet

o ReorderViews

public virtual ReorderViews( ipListOrderedViews)

Change the positions of the views in a sheet according to the given ordered list.

Parameters:

CATIUnknownList

*ipListOrderedViews [in] The ordered list of the views in the sheet. Preconditions:

ValidateViewOrder(ipListOrderedViews) must succeed. @see ValidateViewOrder.

Returns:

A HRESULT

S_OK
Views were reordered.
E_UNEXPECTED
Preconditions not met.
E_FAIL
Internal error.

o SetDefaultActiveView

public virtual SetDefaultActiveView( const iView)

Sets the view which have to be activated in the sheet. By default: - The view have to be added in the sheet before. - The active view is the view in edition.
Note: Do not use this service to activate the background view in UI context, because the command will be canceled by the background workshop activation. Only, in this particular case, it is recommended to edit the sketch by using Openedition and CloseEdition methods defined in CATISktUseSketchEditor interface implemented by the view. These methods allow to manage geometry creation or modification in a view when it is not the active view of a drawing.

Parameters:

const
CATIDftView *iView The default active view in the sheet.

o SetGenViewsPosMode

public virtual SetGenViewsPosMode( iMode)

Changes the stability mode for the position of generative views inside the sheet.
Warning: This method is not available with 2D Layout for 3D Design.

Parameters:

CATDftGenViewsPosMode
iMode [in] the stability mode for generative views.

CATFixedCG
the image of the center of gravity of the 3D data remains at the same position after an update.
CATFixedAxis
the image of the center of gravity of the 3D data moves after an update so that existing and unmodified geometries remain at the same position.

Returns:
a HRESULT

S_OK
Success.
S_FALSE
Success. Nothing was modified since the mode requested was the current mode.
E_FAIL
Failure.

See also:

o SetPrintArea

public virtual SetPrintArea( const iAreaData)

Sets a set of coordinates to define a rectangle print area.

Parameters:

const
double * iAreaData [in] A four double table describing the parameters of the area box:

iAreaData[0] as the low x coordinate of the area.
iAreaData[1] as the low y coordinate of the area.
iAreaData[2] as the width of the area. The value must be strictly positive.
iAreaData[3] as the heigth of the area. The value must be strictly positive.
All the values in the table are given in mm.

Returns:
Un HRESULT

S_OK
The print area was successfully defined.
E_INVALIDARG
The input arguments do not match with specified.
E_FAIL
No print area could be defined.

o SetPrintAreaActivationState

public virtual SetPrintAreaActivationState( const iActivated)

Activates or deactivates the print area.

Parameters:

in
boolean iActivated [in] The activation state of the print area (TRUE means activated, FALSE means deactivated).

Returns:
Un HRESULT

S_OK
The activation state could be valuated.
E_FAIL
No activation or deactivation possible.

o SetProjectionMethod

public virtual SetProjectionMethod( const oProjMethod)

Sets the projection method in this sheet.

Parameters:

const
CATDftProjectionMethod oProjMethod The projection method: - CATFirstAngle: First angle standard. - CATThirdAngle: Third angle standard.

o SetScale

public virtual SetScale( const iScale)

Sets the global scale associated to the sheet. This scale is applied on the sheet views.

Parameters:

const
double iScale The global scale of the sheet

o ValidateViewOrder

public virtual ValidateViewOrder( ipListOrderedViews)

Validates that the given ordered list can be used as an input for ReorderViews. i.e. validates that: iOrderedViews is the result of a permutation applied to the list of all the views of this sheet with the following constraint: iOrderedViews[1] and iOrderedViews[2] must be respectively the sheet's mainview and background view.

Parameters:

CATIUnknownList
*ipListOrderedViews The list of views to validate.

Returns:
An HRESULT value.
Legal values:

S_OK
iOrderedViews is a valid input.
E_XXX
iOrderedViews is not a valid input.

This object is included in the file: CATIDftSheet.h
If needed, your Imakefile.mk should include the module: CATDraftingUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.