All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DraftingInterfaces Interface CATIDrwGenDrawShape

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIDrwGenDrawShape
 

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


interface CATIDrwGenDrawShape

Interface to manage a drawing generated shape.
Role: A generated shape is a shape created in generative section view.


Method Index


o GetBody(CATBody**)
Gets the body of origin.
o GetDescription(int&,CATListOfInt&,CATListPtrCATMathPoint2D&)
Returns the charateristics of the generated shape.
o GetPattern(CATIDftPattern**)
Returns the Pattern associated to the generated shape.
o GetProduct(IID&,IUnknown**)
Gets the product of origin Role: Gets the product including CATPart.

Methods


o GetBody
public virtual HRESULT GetBody(CATBody** oBody) const = 0
Gets the body of origin. Role: Gets the body from which section view as been created.
Postcondition: Don't forget to RELEASE the resulting oBody after use.
Parameters:
oBody
The "coming from" body in the part.
Returns:
HRESULT
S_OK
Body has been found
E_FAIL
No Body found.
o GetDescription
public virtual HRESULT GetDescription(int& oNbContour,
CATListOfInt& oListOfNbPtPerContour,
CATListPtrCATMathPoint2D& oListOfPoints) = 0
Returns the charateristics of the generated shape. Role: Returns the geometrical characteristics of contour(s) composing the generated shape.
Parameters:
oNbContour
Number of contours.
oListOfNbPtPerContour
List of number of points for each contour.
oListOfPoints
List of coordinates of points.
Returns:
HRESULT
S_OK
At least one contour was found
E_FAIL
No contour found.
o GetPattern
public virtual HRESULT GetPattern(CATIDftPattern** oPattern) const = 0
Returns the Pattern associated to the generated shape. Role: Gets the Pattern associated to the generated shape.
Postcondition: Don't forget to RELEASE the resulting oPattern after use.
Parameters:
oPattern
oPattern.
Returns:
HRESULT
S_OK
A pattern has been found
E_FAIL
No pattern found.
o GetProduct
public virtual HRESULT GetProduct( const IID& iIID,
IUnknown** oProduct) const = 0
Gets the product of origin Role: Gets the product including CATPart.
Postcondition: Don't forget to RELEASE the resulting oProduct after use.
Parameters:
iIID
the IID of the returned interface
oProduct
the "coming from" product in the assembly.
Returns:
HRESULT
S_OK
a product has been found
E_FAIL
No product found.

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

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