All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DraftingInterfaces Interface CATIGenerSpec

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---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 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 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 GetClipping(int,CATISketch*&,CATMathDirection&)
Retrieves the clipping definition in a drawing view if exists.
o GetClippingNumber()
Returns the number of clipping operator .
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 GetSection(int&,CATMathPoint*&,int&,CATMathDirection&)
nodoc This method is now replaced by CATIGenerSpec#GetSectionProfile Retrieves the section definition in the drawing 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 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 HRESULT AddBreakOut( const CATISketch_var sketch,
const CATMathVector& vecdir,
const CATMathPlane& plane1,
const CATMathPlane& plane2,
CATIView_var mother_view)=0
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 void AddBreakView( const CATISketch_var sketch,
const CATMathVector2D& vecdir,
CATLISTV(CATISpecObject_var) liste1_skElem,
CATLISTV(CATISpecObject_var) liste2_skElem,
CATIView_var mother_view)= 0
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 HRESULT AddClipping( const CATISketch_var iSketch,
const CATIView_var iMotherView,
int iQuick= 0) = 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 void AddProjection( const CATISketch_var iSketch,
const CATMathDirection& iVecPro,
CATIView_var iMotherView) = 0
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 HRESULT AddSection( const CATISketch_var iSketch,
const int& iDepli,
const int& iSectionType,
const CATMathDirection& iVecPro,
CATIView_var iMotherView,
const int iSectionMode= 0,
const CATBaseUnknown_var i3DSketch= NULL_var,
const CATBaseUnknown_var iProduct= NULL_var) = 0
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 HRESULT Get3DColorInheritance(int& o3DColor,
CATBoolean* IsOverloaded= NULL) = 0
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 int Get3DPointExtractionMode(CATBoolean* IsOverloaded= NULL) = 0
Returns the 3D points extraction mode.
Warning: This method is not available with 2D Layout for 3D Design.
o Get3DPointsSymbol
public virtual HRESULT Get3DPointsSymbol(int& oSymbol,
CATBoolean* IsOverloaded= NULL) = 0
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 CATMathBox2D * GetBBoxOf2DGeneratedGeom()= 0
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 CATLISTV(CATISpecObject_var) GetBreakOutFeatureList()const = 0
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 GetBreakView
public virtual void GetBreakView(CATMathVector2D& ovecdir,
CATLISTV(CATISpecObject_var)& oliste1_skElem,
CATLISTV(CATISpecObject_var)& oliste2_skElem)= 0
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 GetBreakViewFeature
public virtual CATISpecObject_var GetBreakViewFeature()const = 0
Returns the break View operator .
Warning: This method is not available with 2D Layout for 3D Design.
o GetBreakViewInfo
public virtual HRESULT GetBreakViewInfo(CATMathVector2D& ovecdir,
CATLISTV(CATISpecObject_var)& oliste1_skElem,
CATLISTV(CATISpecObject_var)& oliste2_skElem,
CATListOfDouble& otranslation1,
CATListOfDouble& otranslation2)= 0
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 GetClipping
public virtual void GetClipping( const int iClipNum,
CATISketch*& oSketch,
CATMathDirection& oVecPro) = 0
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 GetClippingNumber
public virtual int GetClippingNumber()const = 0
Returns the number of clipping operator .
Warning: This method is not available with 2D Layout for 3D Design.
o GetDetailFeature
public virtual CATISpecObject_var GetDetailFeature()const = 0
Returns the clipping operator .
Warning: This method is not available with 2D Layout for 3D Design.
o GetDetailProfile
public virtual HRESULT GetDetailProfile(CATBoolean& oIsCircular,
CATListPtrCATMathPoint2D& oProfil,
double& oRadius) const = 0
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 HRESULT GetDressUpGeneration( const CATIdent iType,
boolean* oDressGen,
CATBoolean* IsOverloaded= NULL) const =0
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 HRESULT GetFilletRep(CatFilletRepresentation* oFilletRep,
CATBoolean* isOverloaded= NULL) const =0
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 int GetHiddenLinesMode(CATBoolean* IsOverloaded= NULL) const = 0
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 HRESULT GetImageDPIPrecision(RasterLevelOfDetail* oVisuMode,
RasterLevelOfDetail* oPrintMode,
double* oVisu,
double* oPrint) =0
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 HRESULT GetImageMode(int* oMode,
CATBoolean* oLightSourceOn= NULL) =0
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 HRESULT GetLimitBoundingBox(double* oLimit) =0
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 HRESULT GetOcclusionCullingMode(boolean* oMode) =0
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 CATLISTV(CATISpecObject_var) GetOperatorList()= 0
Returns the list of pre-processing operators.
Warning: This method is not available with 2D Layout for 3D Design.
o GetOriginCallout
public virtual HRESULT GetOriginCallout(CATIDrwCalloutAccess** oCallout) const = 0
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 CATMathPlane GetProjPlane()const = 0
Returns the projection plane of the drawing view.
Warning: This method is not available with 2D Layout for 3D Design.
o GetProjectionFeature
public virtual CATISpecObject_var GetProjectionFeature()const = 0
Returns the projection operator .
Warning: This method is not available with 2D Layout for 3D Design.
o GetProjectionProfile
public virtual HRESULT GetProjectionProfile(CATMathPoint[2] oProfile,
CATMathDirection& oVecpro) const = 0
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 GetSection
public virtual void GetSection(int& oNbPoints,
CATMathPoint*& oProfil,
int& oDepli,
CATMathDirection& oVecpro) = 0
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 GetSectionFeature
public virtual CATISpecObject_var GetSectionFeature()const = 0
Returns the section operator .
Warning: This method is not available with 2D Layout for 3D Design.
o GetSectionProfile
public virtual HRESULT GetSectionProfile(CATListPtrCATMathPoint2D& oProfil,
int& oDepli,
CATMathDirection& oVecpro) = 0
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 int GetSectionType()const = 0
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 GetUse3DSpec
public virtual int GetUse3DSpec(CATBoolean* IsOverloaded= NULL) = 0
Returns the Cut/Uncut mode.
Warning: This method is not available with 2D Layout for 3D Design.
o GetWireframeExtractionMode
public virtual int GetWireframeExtractionMode(CATBoolean* IsOverloaded= NULL) = 0
Returns the wireframe extraction mode.
Warning: This method is not available with 2D Layout for 3D Design.
o Set3DColorInheritance
public virtual HRESULT Set3DColorInheritance(int i3DColor) = 0
Valuates the mode of color inheritance, from V5R9.
Warning: This method is not available with 2D Layout for 3D Design.
o Set3DPointExtractionMode
public virtual void Set3DPointExtractionMode(int iPTMode) = 0
Valuates the 3D points extraction mode.
Warning: This method is not available with 2D Layout for 3D Design.
o Set3DPointsSymbol
public virtual HRESULT Set3DPointsSymbol(int iSymbol) = 0
Valuates the symbol of projected points, from V5R9.
Warning: This method is not available with 2D Layout for 3D Design.
o SetDressUpGeneration
public virtual HRESULT SetDressUpGeneration( const CATIdent iType,
const boolean iDressGen) =0
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 HRESULT SetFilletRep( const CatFilletRepresentation iFilletRep) =0
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 void SetHiddenLinesMode( const int iHiddenMode) const = 0
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 HRESULT SetImageDPIPrecision( const RasterLevelOfDetail iVisuMode,
const RasterLevelOfDetail iPrintMode,
const double iVisu,
const double iPrint) =0
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 HRESULT SetImageMode( const int iMode,
CATBoolean iLightSourceOn= TRUE) =0
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 HRESULT SetLimitBoundingBox( const double iLimit) =0
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 HRESULT SetOcclusionCullingMode( const boolean iMode) =0
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 void SetProjPlane( const CATMathPlane& iProjectionPlane) = 0
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 void SetUse3DSpec(int iUseOrNot) = 0
Valuates the Cut/Uncut mode.
Warning: This method is not available with 2D Layout for 3D Design.
o SetWireframeExtractionMode
public virtual void SetWireframeExtractionMode(int iWFMode) = 0
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.