All Frameworks  Class Hierarchy  This Framework  Indexes   

DraftingInterfaces Interface CATIGenerSpec

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


interface CATIGenerSpec

Interface to the specifications of a generative drawing view.
Role: This interface manages the specifications of a generative drawing view. These specifications are:


Method Index


o AddBreakOut(CATISketch_var,CATMathVector&,CATMathPlane&,CATMathPlane&,CATIView_var)
Adds the break out operator.
o AddBreakView(CATISketch_var,CATMathVector2D&,CATLISTV(CATISpecObject_var),CATLISTV(CATISpecObject_var),CATIView_var)
Adds a specification of auxiliary on the drawing view.
o AddClipping(CATISketch_var,CATIView_var,int)
Adds a specification of detail on the drawing view.
o AddProjection(CATISketch_var,CATMathDirection&,CATIView_var)
Adds a specification of auxiliary on the drawing view.
o AddSection(CATISketch_var,int&,int&,CATMathDirection&,CATIView_var,int,CATBaseUnknown_var,CATBaseUnknown_var)
Adds a specification of section or section cut on the drawing view.
o Get3DColorInheritance(int&,CATBoolean*)
Returns the mode of color inheritance, from V5R9.
o Get3DPointExtractionMode(CATBoolean*)
Returns the 3D points extraction mode.
o Get3DPointsSymbol(int&,CATBoolean*)
Returns the symbol of projected points, from V5R9.
o GetBBoxOf2DGeneratedGeom()
Returns the bounding box of the 2D Generated Geometry.
o GetBreakOutFeatureList()
Returns the list of break out operators.
o GetBreakViewFeature()
Returns the break View operator .
o GetBreakViewInfo(CATMathVector2D&,CATLISTV(CATISpecObject_var)&,CATLISTV(CATISpecObject_var)&,CATListOfDouble&,CATListOfDouble&)
Retrieves the BreakView definition in the drawing view.
o GetBreakView(CATMathVector2D&,CATLISTV(CATISpecObject_var)&,CATLISTV(CATISpecObject_var)&)
nodoc This method is now replaced by CATIGenerSpec#GetBreakViewInfo Retrieves the BreakView definition in the drawing view.
o GetClippingNumber()
Returns the number of clipping operator .
o GetClipping(int,CATISketch*&,CATMathDirection&)
Retrieves the clipping definition in a drawing view if exists.
o GetDetailFeature()
Returns the clipping operator .
o GetDetailProfile(CATBoolean&,CATListPtrCATMathPoint2D&,double&)
Returns geometric informations about profile for detail view.
o GetDressUpGeneration(CATIdent,boolean*,CATBoolean*)
Retrieves if symbolic annotations will be generated from design.
o GetFilletRep(CatFilletRepresentation*,CATBoolean*)
Retrieves the generative view fillets representation.
o GetHiddenLinesMode(CATBoolean*)
Returns the mode of representation of hidden lines.
o GetImageDPIPrecision(RasterLevelOfDetail*,RasterLevelOfDetail*,double*,double*)
Retrieves the generated image definition in dpi, for visualization and print purposes.
o GetImageMode(int*,CATBoolean*)
Retrieves the pixel image generation mode.
o GetLimitBoundingBox(double*)
Retrieves the bounding box limits under which a part will not be taken into account during view generation.
o GetOcclusionCullingMode(boolean*)
Retrieves the Occlusion Culling mode for generating views.
o GetOperatorList()
Returns the list of pre-processing operators.
o GetOriginCallout(CATIDrwCalloutAccess**)
Gets the callout defining the view.
o GetProjPlane()
Returns the projection plane of the drawing view.
o GetProjectionFeature()
Returns the projection operator .
o GetProjectionProfile(CATMathPoint[2],CATMathDirection&)
Returns geometric informations about profile for auxiliary view.
o GetSectionFeature()
Returns the section operator .
o GetSectionProfile(CATListPtrCATMathPoint2D&,int&,CATMathDirection&)
Retrieves the section definition in the drawing view.
o GetSectionType()
Returns the type of the section.
o GetSection(int&,CATMathPoint*&,int&,CATMathDirection&)
nodoc This method is now replaced by CATIGenerSpec#GetSectionProfile Retrieves the section definition in the drawing view.
o GetUse3DSpec(CATBoolean*)
Returns the Cut/Uncut mode.
o GetWireframeExtractionMode(CATBoolean*)
Returns the wireframe extraction mode.
o Set3DColorInheritance(int)
Valuates the mode of color inheritance, from V5R9.
o Set3DPointExtractionMode(int)
Valuates the 3D points extraction mode.
o Set3DPointsSymbol(int)
Valuates the symbol of projected points, from V5R9.
o SetDressUpGeneration(CATIdent,boolean)
Sets the kind of annotation which have to be generated from design.
o SetFilletRep(CatFilletRepresentation)
Sets the generative view fillets representation.
o SetHiddenLinesMode(int)
Sets the mode of representation of hidden lines.
o SetImageDPIPrecision(RasterLevelOfDetail,RasterLevelOfDetail,double,double)
Sets the generated image definition in dpi, for visualization and print purposes.
o SetImageMode(int,CATBoolean)
Sets the pixel image generation mode.
o SetLimitBoundingBox(double)
Sets the bounding box limits under which a part will not be taken into account during view generation.
o SetOcclusionCullingMode(boolean)
Sets the Occlusion Culling mode for generating views.
o SetProjPlane(CATMathPlane&)
Sets the projection plane of the drawing view.
o SetUse3DSpec(int)
Valuates the Cut/Uncut mode.
o SetWireframeExtractionMode(int)
Valuates the wireframe extraction mode.

Methods


o AddBreakOut
public virtual AddBreakOut( const sketch,
const vecdir,
const plane1,
const plane2,
mother_view)
Adds the break out operator.
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
iSketch
The Sketch which contains the geometry's description of the breakout profile
vecdir
The direction of the breakout
plane1
First breakout reference plane
plane2
Second breakout reference plane
mother_view
The view in which the breakout is applied.
Returns:
S_OK
if the breakout was correctly added.
S_FALSE
if the breakout was added but the needed callbacks for a normal behavior were not set.
E_FAIL
if the operation failed.
o AddBreakView
public virtual AddBreakView( const sketch,
const vecdir,
liste1_skElem,
liste2_skElem,
mother_view)
Adds a specification of auxiliary on the drawing view. Role: This methods adds a auxiliary (or projection) operator on the drawing view which will be then considered as an Auxiliary View. An Auxiliary View is a drawing view which represents a 3D Part in a direction defined in another view (called the mother view here) The definition of the direction of projection is contained in the sketch
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
iSketch
The Sketch which contains the geometry's description of the direction of projection (a line perpendicular to this direction in the mother view)
iVecPro
The direction of projection of the view
iMotherView
The View in which the direction of projection is defined
o AddClipping
public virtual AddClipping( const iSketch,
const iMotherView,
iQuick= 0)
Adds a specification of detail on the drawing view. Role: This methods adds a detail operator on the drawing view which will be then considered as a Detail View. A Detail View is a drawing view which represents a subpart of another view (called the mother view here) The definition of the subpart geometry (or clipping area) is contained in the sketch
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
iSketch
The Sketch which contains the geometry's description of the clipping area
Legal values: iSketch must contain a closed profile
iMotherView
The View in which the clipping area is defined and of which the Detail View is a magnified representation
iQuick
Defines the computation mode
Legal values: 0: the 3D model is clipped and then pojected, 1: the clipping is a pure 2D operation (quicker!)
Returns:
S_OK
if the clipping was correctly added.
S_FALSE
if the clipping was added but the needed callbacks for a normal behavior were not set.
E_FAIL
if the operation failed.
o AddProjection
public virtual AddProjection( const iSketch,
const iVecPro,
iMotherView)
Adds a specification of auxiliary on the drawing view. Role: This methods adds a auxiliary (or projection) operator on the drawing view which will be then considered as an Auxiliary View. An Auxiliary View is a drawing view which represents a 3D Part in a direction defined in another view (called the mother view here) The definition of the direction of projection is contained in the sketch
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
iSketch
The Sketch which contains the geometry's description of the direction of projection (a line perpendicular to this direction in the mother view)
iVecPro
The direction of projection of the view
iMotherView
The View in which the direction of projection is defined
o AddSection
public virtual AddSection( const iSketch,
const iDepli,
const iSectionType,
const iVecPro,
iMotherView,
const iSectionMode= 0,
const i3DSketch= NULL_var,
const iProduct= NULL_var)
Adds a specification of section or section cut on the drawing view. Role: This methods adds a section (or section cut) operator on the drawing view which will be then considered as a Section View (or a Section Cut View). The definition of the section profile is described in a sketch
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
iSketch
The Sketch which contains the geometry's description of the section profile
iDepli
Defines if the section is offset or aligned
Legal values: 0: offset, 1: aligned
iSectionType
Defines if the section is a section cut or a section
Legal values: 0: section, 1: section cut
iVecPro
The direction of projection of the view
iMotherView
The View in which the section profile is defined and of which the Section (or Section Cut) View is a section
iSectionMode
Defines if the Section View is according to profile or not.
Legal values: 0: mother view orientation, 1: according to profile
i3DSketch
In the case of a 3D defined profile, this is the 3D sketch containing the geometry's description of the section profile
Legal values: if NULL_var, the profile is defined in the drawing
iProduct
In the case of a 3D defined profile, this is the product containing i3DSketch
Legal values: if NULL_var, the profile is defined in the drawing
Returns:
S_OK
if the section was correctly added.
S_FALSE
if the section was added but the needed callbacks for a normal behavior were not set.
E_FAIL
if the operation failed.
o Get3DColorInheritance
public virtual Get3DColorInheritance( o3DColor,
IsOverloaded= NULL)
Returns the mode of color inheritance, from V5R9.
Warning: This method is not available with 2D Layout for 3D Design.
Returns:
0: no inheritance, 1: inheritance
o Get3DPointExtractionMode
public virtual Get3DPointExtractionMode( IsOverloaded= NULL)
Returns the 3D points extraction mode.
Warning: This method is not available with 2D Layout for 3D Design.
o Get3DPointsSymbol
public virtual Get3DPointsSymbol( oSymbol,
IsOverloaded= NULL)
Returns the symbol of projected points, from V5R9.
Warning: This method is not available with 2D Layout for 3D Design.
Returns:
0: inheritance from 3D point other: the symbol number
o GetBBoxOf2DGeneratedGeom
public virtual GetBBoxOf2DGeneratedGeom()
Returns the bounding box of the 2D Generated Geometry. May return NULL.
Warning: This method is not available with 2D Layout for 3D Design.
o GetBreakOutFeatureList
public virtual GetBreakOutFeatureList()
Returns the list of break out operators.
Returns an empty list if it founds no BreakOut in the view.
Warning: This method is not available with 2D Layout for 3D Design.
o GetBreakViewFeature
public virtual GetBreakViewFeature()
Returns the break View operator .
Warning: This method is not available with 2D Layout for 3D Design.
o GetBreakViewInfo
public virtual GetBreakViewInfo( ovecdir,
oliste1_skElem,
oliste2_skElem,
otranslation1,
otranslation2)
Retrieves the BreakView definition in the drawing view.
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
ovecdir
Direction of break
oliste1_skElem
A list of sketch elements which describe the shape of first BrokenLines
oliste2_skElem
A list of double sketch elements which describe the shape of second BrokenLines
otranslation1
A list of double which describe translation associated to the shape of first BrokenLines
otranslation2
A list of double which describe translation associated to the shape of second BrokenLines
Returns:
S_OK
Execution successfully.
E_FAIL
iExecution failed.
o GetBreakView
public virtual GetBreakView( ovecdir,
oliste1_skElem,
oliste2_skElem)
nodoc This method is now replaced by CATIGenerSpec#GetBreakViewInfo Retrieves the BreakView definition in the drawing view.
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
ovecdir
Direction of break
oliste1_skElem
A list of sketch elements which describe the shape of first BrokenLines
oliste2_skElem
A list of sketch elements which describe the shape of second BrokenLines
o GetClippingNumber
public virtual GetClippingNumber()
Returns the number of clipping operator .
Warning: This method is not available with 2D Layout for 3D Design.
o GetClipping
public virtual GetClipping( const iClipNum,
oSketch,
oVecPro)
Retrieves the clipping definition in a drawing view if exists.
Parameters:
iClipNum
Not used. Must be always 1.
Warning: This method is not available with 2D Layout for 3D Design.
oSketch
The sketch which contains the geometry's description of the clipping area
oVecPro
The direction of projection of the view
o GetDetailFeature
public virtual GetDetailFeature()
Returns the clipping operator .
Warning: This method is not available with 2D Layout for 3D Design.
o GetDetailProfile
public virtual GetDetailProfile( oIsCircular,
oProfil,
oRadius)
Returns geometric informations about profile for detail view.
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
oIsCircular
oIsCircular is true means profile is only defined by a circle.
oProfile
Profile defined by a list of points. if Profile is circular, there only one point in the list to return cirlce center.
oRadius
Radius of circle
Returns:
HRESULT
S_OK
Profile has been found
E_FAIL
No profile found.
o GetDressUpGeneration
public virtual GetDressUpGeneration( const iType,
oDressGen,
IsOverloaded= NULL)
Retrieves if symbolic annotations will be generated from design.
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
iType
The type of annotation
oDressGen
TRUE if generated, FALSE if not
o GetFilletRep
public virtual GetFilletRep( oFilletRep,
isOverloaded= NULL)
Retrieves the generative view fillets representation.
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
oFilletRep
The different modes of representation
Legal values Possible values are NONE (filets are not represented), BOUNDARY (fillets are represented by their boundary edges) or ORIGINALEDGE (fillets are symbolicly represented)
o GetHiddenLinesMode
public virtual GetHiddenLinesMode( IsOverloaded= NULL)
Returns the mode of representation of hidden lines.
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
isOverloaded
Returns:
The mode of representation: 0: not represented, 1: represented
o GetImageDPIPrecision
public virtual GetImageDPIPrecision( oVisuMode,
oPrintMode,
oVisu,
oPrint)
Retrieves the generated image definition in dpi, for visualization and print purposes.
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
oVisuMode
The precision mode for visualization.
Accepted values: LowQuality, NormalQuality, HighQuality, or Customize (if you want to define the dpi for visualization and print purposes yourself).
oPrintMode
The precision mode for print purposes.
Accepted values: LowQuality, NormalQuality, HighQuality, or Customize (if you want to define the dpi for visualization and print purposes yourself).
oVisu
The definition in dpi for visualization (number of pixels per inch in the sheet).
oPrint
The definition in dpi for print purposes.
Returns:
S_OK
if the operation succeeded,
E_INVALIDARG
if argument pointer NULL,
E_FAIL
if an unspecified failure occurred.
o GetImageMode
public virtual GetImageMode( oMode,
oLightSourceOn= NULL)
Retrieves the pixel image generation mode.
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
oMode
The
CATViewModeType used to generate the image
Accepted values: VIEW_NO_DISPLAY (no image generated), VIEW_HRD, VIEW_MESH or (VIEW_MESH | VIEW_EDGE)
oLightSourceOn
To get spot light source activation
Returns:
S_OK
if the operation succeeded,
E_INVALIDARG
if argument pointer NULL,
E_FAIL
if an unspecified failure occurred.
o GetLimitBoundingBox
public virtual GetLimitBoundingBox( oLimit)
Retrieves the bounding box limits under which a part will not be taken into account during view generation.
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
oLimit
The limit value. 0. means that no part will be filtered.
Returns:
S_OK
if the operation succeeded,
E_INVALIDARG
if argument pointer NULL,
E_FAIL
if an unspecified failure has occurred.
o GetOcclusionCullingMode
public virtual GetOcclusionCullingMode( oMode)
Retrieves the Occlusion Culling mode for generating views. Occlusion Culling uses the graphic card to improve performance during view generation, by avoiding the loading of hidden bodies.
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
oMode
TRUE if Occlusion Culling is available, FALSE if not.
Returns:
S_OK
if the operation succeeded.
E_INVALIDARG
if argument pointer NULL,
E_FAIL
if an unspecified failure has occurred.
o GetOperatorList
public virtual GetOperatorList()
Returns the list of pre-processing operators.
Warning: This method is not available with 2D Layout for 3D Design.
o GetOriginCallout
public virtual GetOriginCallout( oCallout)
Gets the callout defining the view. Role: Gets the callout defining the view.
Postcondition: Don't forget to RELEASE the resulting oCallout after use.
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
oCallout
The callout defining the view.
Returns:
HRESULT
S_OK
Callout has been found
E_FAIL
No callout found or internal error.
o GetProjPlane
public virtual GetProjPlane()
Returns the projection plane of the drawing view.
Warning: This method is not available with 2D Layout for 3D Design.
o GetProjectionFeature
public virtual GetProjectionFeature()
Returns the projection operator .
Warning: This method is not available with 2D Layout for 3D Design.
o GetProjectionProfile
public virtual GetProjectionProfile( oProfile,
oVecpro)
Returns geometric informations about profile for auxiliary view.
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
oProfile
two points defining profile.
iVecPro
The direction of projection of the view
Returns:
HRESULT
S_OK
Profile has been found
E_FAIL
No profile found.
o GetSectionFeature
public virtual GetSectionFeature()
Returns the section operator .
Warning: This method is not available with 2D Layout for 3D Design.
o GetSectionProfile
public virtual GetSectionProfile( oProfil,
oDepli,
oVecpro)
Retrieves the section definition in the drawing view.
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
oProfil
List of CATMathPoint which contains the profile's points.
oDepli
Defines if the section is offset or aligned. 0: offset, 1: aligned
oVecPro
The direction of projection of the view
o GetSectionType
public virtual GetSectionType()
Returns the type of the section.
Warning: This method is not available with 2D Layout for 3D Design.
Returns:
0: section, 1: section cut
o GetSection
public virtual GetSection( oNbPoints,
oProfil,
oDepli,
oVecpro)
nodoc This method is now replaced by CATIGenerSpec#GetSectionProfile Retrieves the section definition in the drawing view.
Parameters:
oNbPoints
The number of points in the profile
oProfil
An array of CATMathPoint which contains the profile's points. !!!!!! Memory is allocated, so you must delete it after use. !!!!!!
Warning: This method is not available with 2D Layout for 3D Design.
oDepli
Defines if the section is offset or aligned. 0: offset, 1: aligned
oVecPro
The direction of projection of the view
o GetUse3DSpec
public virtual GetUse3DSpec( IsOverloaded= NULL)
Returns the Cut/Uncut mode.
Warning: This method is not available with 2D Layout for 3D Design.
o GetWireframeExtractionMode
public virtual GetWireframeExtractionMode( IsOverloaded= NULL)
Returns the wireframe extraction mode.
Warning: This method is not available with 2D Layout for 3D Design.
o Set3DColorInheritance
public virtual Set3DColorInheritance( i3DColor)
Valuates the mode of color inheritance, from V5R9.
Warning: This method is not available with 2D Layout for 3D Design.
o Set3DPointExtractionMode
public virtual Set3DPointExtractionMode( iPTMode)
Valuates the 3D points extraction mode.
Warning: This method is not available with 2D Layout for 3D Design.
o Set3DPointsSymbol
public virtual Set3DPointsSymbol( iSymbol)
Valuates the symbol of projected points, from V5R9.
Warning: This method is not available with 2D Layout for 3D Design.
o SetDressUpGeneration
public virtual SetDressUpGeneration( const iType,
const iDressGen)
Sets the kind of annotation which have to be generated from design.
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
iType
The type of annotation to be generated or not
iDressGen
TRUE if generated, FALSE if not
o SetFilletRep
public virtual SetFilletRep( const iFilletRep)
Sets the generative view fillets representation.
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
iFilletRep
The different modes of representation
Legal values: Possible values are NONE (filets are not represented), BOUNDARY (fillets are represented by their boundary edges) or ORIGINALEDGE (fillets are symbolicly represented)
o SetHiddenLinesMode
public virtual SetHiddenLinesMode( const iHiddenMode)
Sets the mode of representation of hidden lines.
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
iHiddenMode
The mode of representation
Legal values: 0: not represented, 1: represented
o SetImageDPIPrecision
public virtual SetImageDPIPrecision( const iVisuMode,
const iPrintMode,
const iVisu,
const iPrint)
Sets the generated image definition in dpi, for visualization and print purposes.
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
iVisuMode
The precision mode for visualization.
Accepted values: LowQuality, NormalQuality, HighQuality, or Customize (if you want to define the dpi for visualization and print purposes yourself).
iPrintMode
The precision mode for print purposes.
Accepted values: LowQuality, NormalQuality, HighQuality, or Customize (if you want to define the dpi for visualization and print purposes yourself). * @param iVisu The definition in dpi for visualization (number of pixels per inch in the sheet).
iPrint
The definition in dpi for print purposes.
Returns:
S_OK
if the operation succeeded,
E_INVALIDARG
if an argument is negative,
E_FAIL
if an unspecified failure has occurred.
o SetImageMode
public virtual SetImageMode( const iMode,
iLightSourceOn= TRUE)
Sets the pixel image generation mode. Image generation mode is exclusive from current 2D geometry generation.
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
iMode
The
CATViewModeType used to generate the image
Accepted values: VIEW_NO_DISPLAY (no image generated), VIEW_HRD VIEW_MESH or (VIEW_MESH | VIEW_EDGE)
iLightSourceOn
To set spot light source activation (default value activated)
Returns:
S_OK
if the operation succeeded,
E_INVALIDARG
if the argument is different from accepted values
E_FAIL
if an unspecified failure occurred, or the current view operators are not compatible with pixel image generation mode.
o SetLimitBoundingBox
public virtual SetLimitBoundingBox( const iLimit)
Sets the bounding box limits under which a part will not be taken into account during view generation.
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
iLimit
The limit value. Set it to 0. to disable this filter.
Returns:
S_OK
if the operation succeeded.
E_FAIL
if an unspecified failure has occurred.
o SetOcclusionCullingMode
public virtual SetOcclusionCullingMode( const iMode)
Sets the Occlusion Culling mode for generating views. Occlusion Culling uses the graphic card to improve performance during view generation, by avoiding the loading of hidden bodies.
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
iMode
TRUE to enable Occlusion Culling, FALSE if not.
Returns:
S_OK
if the operation succeeded,
E_FAIL
if an unspecified failure has occurred.
o SetProjPlane
public virtual SetProjPlane( const iProjectionPlane)
Sets the projection plane of the drawing view.
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
iProjectionPlane
A CATMathPlane describing the projection plane
o SetUse3DSpec
public virtual SetUse3DSpec( iUseOrNot)
Valuates the Cut/Uncut mode.
Warning: This method is not available with 2D Layout for 3D Design.
o SetWireframeExtractionMode
public virtual SetWireframeExtractionMode( iWFMode)
Valuates the wireframe extraction mode.
Warning: This method is not available with 2D Layout for 3D Design.

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

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