All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

Drafting2DLInterfaces Interface CATI2DLayoutClipping

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---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); CATI2DLayoutView


Method Index


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

Methods


o GetBackClippingActivation
public virtual HRESULT GetBackClippingActivation(CATBoolean& oActivation)=0
RoleGet the activation of the back clipping plane.
Parameters:
oActivation
[out] the activation, TRUE to activate, FALSE to deactivate. S_OK if succeeded, E_XXX if failed
o GetBackClippingOffset
public virtual HRESULT GetBackClippingOffset(double& oOffset)=0
RoleGet 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 HRESULT GetClipCircle(CATMathPoint2D& oCenter,
double& oRadius)=0
RoleGet 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 HRESULT GetClipPolygon(CATListPtrCATMathPoint2D& oList)=0
RoleGet 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 HRESULT GetClipProfileMode(CAT2DLClippingProfileMode& oClipProfileMode)=0
RoleGet 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 HRESULT GetClipRectangle(double& oXMin,
double& oXMax,
double& oYMin,
double& oYMax)=0
RoleGet 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 HRESULT IsBackClippingOffsetDefined(CATBoolean& oDefined)=0
RoleChecks 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 HRESULT IsClipCircleDefined(CATBoolean& oDefined)=0
RoleChecks 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 HRESULT IsClipPolygonDefined(CATBoolean& oDefined)=0
RoleChecks 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 HRESULT IsClipRectangleDefined(CATBoolean& oDefined)=0
RoleChecks 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 HRESULT SetBackClippingActivation(CATBoolean iActivation)=0
RoleSet the activation of the back clipping plane.
Parameters:
iActivation
the activation, TRUE to activate, FALSE to deactivate. S_OK if succeeded, E_XXX if failed
o SetBackClippingOffset
public virtual HRESULT SetBackClippingOffset(double iOffset)=0
RoleSet 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 HRESULT SetClipCircle( const CATMathPoint2D& iCenter,
double iRadius)=0
RoleSet 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 HRESULT SetClipPolygon( const CATListPtrCATMathPoint2D& iList)=0
RoleSet 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 HRESULT SetClipProfileMode(CAT2DLClippingProfileMode iClipProfileMode)=0
RoleSet the mode of the clipping profile.
Precondition The corresponding data must be defined before the clipping mode activation. Example: activating circle clipping when IsClipCircleDefined returns FALSE will fail. You first have to call SetClipCircle, and then use SetClipProfileMode.
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 HRESULT SetClipRectangle(double iXMin,
double iXMax,
double iYMin,
double iYMax)=0
RoleSet 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: CATDrafting2DLItfCPP

Copyright © 2003, Dassault Systèmes. All rights reserved.