All Frameworks Class Hierarchy This Framework Indexes Previous Next

Drafting2DLUseItf Interface CATI2DLayoutClipping

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

interface CATI2DLayoutClipping

This interface manages the clipping applied by a 2D Layout View.

Role: This interface is implemented by the 2DLView

Example:

   CATI2DLayoutClipping* pi2DLClipping = NULL;
  rc = my2DLVIew->QueryInterface(IID_CATI2DLayoutClipping,
                                     (void**) &pi2DLClipping);

Method Index

o GetBackClippingActivation(CATBoolean&): Gets the activation of the back clipping plane.
o GetBackClippingOffset(double&): Gets the offset of the back clipping plane from the view plane.
o GetClipCircle(CATMathPoint2D&,double&): Gets the data for the circle clipping profile.
o GetClipPolygon(CATListPtrCATMathPoint2D&): Gets the data for the polygon clipping profile.
o GetClipProfileMode(CAT2DLClippingProfileMode&): RoleGets the mode of clipping profile.
o GetClipRectangle(double&,double&,double&,double&): Gets the data for the rectangle clipping profile.
o IsBackClippingOffsetDefined(CATBoolean&): Checks if the the offset of the back clipping plane is defined.
o IsClipCircleDefined(CATBoolean&): Checks if the circle data are defined.
o IsClipPolygonDefined(CATBoolean&): Checks if the polygon data are defined.
o IsClipRectangleDefined(CATBoolean&): Checks if the rectangle data are defined.
o SetBackClippingActivation(CATBoolean): Sets the activation of the back clipping plane.
o SetBackClippingOffset(double): Sets the offset of the back clipping plane from the view plane.
o SetClipCircle(CATMathPoint2D&,double): Sets the data for the circle clipping profile.
o SetClipPolygon(CATListPtrCATMathPoint2D&): Sets the data for the polygon clipping profile.
o SetClipProfileMode(CAT2DLClippingProfileMode): Sets the mode of the clipping profile.
o SetClipRectangle(double,double,double,double): Sets the data for the rectangle clipping profile.

Methods

o GetBackClippingActivation

public virtual GetBackClippingActivation( oActivation)

Gets the activation of the back clipping plane.

Parameters:

oActivation: [out] the activation, TRUE to activate, FALSE to deactivate.

Returns:

S_OK if succeeded, E_XXX if failed

o GetBackClippingOffset

public virtual GetBackClippingOffset( oOffset)

Gets the offset of the back clipping plane from the view plane.

Parameters:

oOffset: [out] The offset of the back clipping plane.

Returns:

S_OK if succeeded, E_XXX if failed (can be invalid inputs)

o GetClipCircle

public virtual GetClipCircle(		`oCenter`,
		`oRadius`)

Gets the data for the circle clipping profile.
Precondition IsClipCircleDefined method must return TRUE before the usage of this method.

Parameters:

oCenter: [out] the center of the circle in view space coordinates.
iRadius: the radius of the circle in view space coordinates.

Returns:

S_OK if succeeded, E_XXX if failed

o GetClipPolygon

public virtual GetClipPolygon( oList)

Gets the data for the polygon clipping profile.
Precondition IsClipPolygonDefined method must return TRUE before the usage of this method.

Parameters:

oList: [out] a list of 2D points (in view space coordinates) that represents the polygon. The list represents the vertices of the polygon; each edge is defined by taking a point and the next one. For the last point, an edge is created by taking the last point and the first one (so the polygon is automatically closed without having to append the first point at the end of the list).

Returns:

S_OK if succeeded, E_XXX if failed

o GetClipProfileMode

public virtual GetClipProfileMode( oClipProfileMode)

RoleGets the mode of clipping profile.

Parameters:

oClipProfileMode: [out] the mode of clipping

Returns:

S_OK is succeeded, E_XXX if failed

o GetClipRectangle

public virtual GetClipRectangle(		`oXMin`,
		`oXMax`,
		`oYMin`,
		`oYMax`)

Gets the data for the rectangle clipping profile.
Precondition IsClipRectangleDefined method must return TRUE before the usage of this method.

Parameters:

oXMin: [out] the xmin.
oXMax: [out] the xmax
oYMin: [out] the ymin
oYMax: [out] the ymax

Returns:

S_OK if succeeded, E_XXX if failed (can be invalid inputs)

o IsBackClippingOffsetDefined

public virtual IsBackClippingOffsetDefined( oDefined)

Checks if the the offset of the back clipping plane is defined.

Parameters:

oDefined: [out] the defined state

Returns:

S_OK if succeeded, E_XXX if failed

o IsClipCircleDefined

public virtual IsClipCircleDefined( oDefined)

Checks if the circle data are defined.

Parameters:

oDefined: [out] the defined state

Returns:

S_OK if succeeded, E_XXX if failed

o IsClipPolygonDefined

public virtual IsClipPolygonDefined( oDefined)

Checks if the polygon data are defined.

Parameters:

oDefined: [out] the defined state

Returns:

S_OK if succeeded, E_XXX if failed

o IsClipRectangleDefined

public virtual IsClipRectangleDefined( oDefined)

Checks if the rectangle data are defined.

Parameters:

oDefined: [out] the defined state

Returns:

S_OK if succeeded, E_XXX if failed

o SetBackClippingActivation

public virtual SetBackClippingActivation( iActivation)

Sets the activation of the back clipping plane.

Parameters:

iActivation: the activation, TRUE to activate, FALSE to deactivate.

Returns:

S_OK if succeeded, E_XXX if failed

o SetBackClippingOffset

public virtual SetBackClippingOffset( iOffset)

Sets the offset of the back clipping plane from the view plane.

Parameters:

iOffset: The offset of the back clipping plane.
Precondition ioffset must be a positive value.

Returns:

S_OK if succeeded, E_XXX if failed (can be invalid inputs)

o SetClipCircle

public virtual SetClipCircle(	const	`iCenter`,
		`iRadius`)

Sets the data for the circle clipping profile.
Precondition Geometry defining the profile must be inside the model limits.

Parameters:

iCenter: the center of the circle in view space coordinates.
iRadius: the radius of the circle in view space coordinates.

Returns:

S_OK if succeeded, E_XXX if failed (can be invalid inputs)

o SetClipPolygon

public virtual SetClipPolygon( const iList)

Sets the data for the polygon clipping profile.
Precondition Geometry defining the profile must be inside the model limits.

Parameters:

iList: a list of 2D points (in view space coordinates) that represents the polygon. The list represents the vertices of the polygon; each edge is defined by taking a point and the next one. For the last point, an edge is created by taking the last point and the first one (so the polygon is automatically closed without having to append the first point at the end of the list). The polygon must not be complex (it must have non-intersecting boundaries). Each point should respect: All the points defining the polygon must be distincted. All the points must be inside the model limits. The list should contain at least 3 points (that will be a triangle).

Returns:

S_OK if succeeded, E_XXX if failed (can be invalid inputs)

o SetClipProfileMode

public virtual SetClipProfileMode( iClipProfileMode)

Sets the mode of the clipping profile.
Precondition The corresponding data must be defined before the clipping mode activation.

Parameters:

iClipProfileMode: The mode to use

Returns:

S_OK is succeeded, E_XXX if failed (that can happen when switching to a mode whose data are not yet initialized)

o SetClipRectangle

public virtual SetClipRectangle(		`iXMin`,
		`iXMax`,
		`iYMin`,
		`iYMax`)

Sets the data for the rectangle clipping profile.
Precondition Geometry defining the profile must be inside the model limits.

Parameters:

iXMin: the xmin.
iXMax: the xmax
iYMin: the ymin
iYMax: the ymax

Returns:

S_OK if succeeded, E_XXX if failed (can be invalid inputs)

This object is included in the file: CATI2DLayoutClipping.h
If needed, your Imakefile.mk should include the module: CATDrafting2DLUseItf