All Frameworks Class Hierarchy This Framework Indexes
DraftingInterfaces Interface CATIDftGenView
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDftGenView
Interface to retrieve attributs dedicated to generative drawing views.
Role: This interface to retrieve informations dedicated to generative drawing views.
Method Index
- o
GetBox3DOptions(CATDrwGenBox3DType&,CATDrwGenBox3DMode&)
- Gets parameters on a box operator.
- o
GetBox3D(CATMathPoint*,CATMathPoint*,CATMathPoint*,CATMathPoint*)
- Retrieves box mathematical definition.
- o
GetProjectionPlane(CATMathPlane**)
- Returns the projection plane on the Generative View.
- o
IsBox3DModifiable(CATBoolean*)
- Used to know if the Box3D definition comes from an external object (i.
- o
IsGenerative(boolean*)
- Used to know if the view is generative.
- o
IsShowHidden(boolean*)
- Gets the generative view hidden line representation.
- o
IsShowSmooth(boolean*)
- Gets the generative view smooth edges representation.
- o
RemoveBox3D()
- Removes a box3D operator in the view.
- o
SetBox3DOptions(CATDrwGenBox3DType,CATDrwGenBox3DMode)
- Sets parameters on a box operator.
- o
SetBox3D(CATMathPoint*,CATMathPoint*,CATMathPoint*,CATMathPoint*)
- Sets or create a clipping box (not available if a DMUBox already exists on the view).
- o
SetProjectionPlane(CATMathPlane*)
- Sets the projection plane on the Generative View.
- o
SetShowHidden(boolean)
- Sets the generative view hidden line representation.
- o
SetShowSmooth(boolean)
- Sets the generative view smooth edges representation.
Methods
o GetBox3DOptions
| public virtual GetBox3DOptions( | | oClippingType, |
| | oClippingMode) |
-
Gets parameters on a box operator.
- Parameters:
-
- oClippingType
- (box, slice or back clipping plane)
- oClippingMode
- ** NOT IMPLEMENTED **
- Returns:
-
- S_OK
- if operation succeeded.
- E_FAIL
- if a box does not exist on the view
o GetBox3D
| public virtual GetBox3D( | | oPointA, |
| | oPointB, |
| | oPointC, |
| | oPointD) |
-
Retrieves box mathematical definition.
- Parameters:
-
- oBox
- The box as xmin, xmax, ymin, ymax, zmin, zmax
o GetProjectionPlane
| public virtual GetProjectionPlane( | | oPlane) |
-
Returns the projection plane on the Generative View.
- Parameters:
-
- oPlane
- the CATMathPlane wich describes the projection plane of the view
o IsBox3DModifiable
| public virtual IsBox3DModifiable( | | oBoxModifiable) |
-
Used to know if the Box3D definition comes from an external object (i.e. DMUBOX).
- Parameters:
-
- oBoxModifiable
- TRUE = standalone box
FALSE = box created with an external link (i.e. DMUBOX)
o IsGenerative
| public virtual IsGenerative( | | oGenStatus) |
-
Used to know if the view is generative.
- Parameters:
-
- oGenStatus
-
TRUE = A result is generated from 3D
FALSE = The view isn't generative
o IsShowHidden
| public virtual IsShowHidden( | | oShowHidden) |
-
Gets the generative view hidden line representation.
- Parameters:
-
- oShowHidden
-
TRUE = Hidden lines are show
FALSE = Hidden lines are not show
o IsShowSmooth
| public virtual IsShowSmooth( | | oShowSmooth) |
-
Gets the generative view smooth edges representation.
- Parameters:
-
- oShowSmooth
-
TRUE = Smooth edges are show
FALSE = Smooth edges are not show
o RemoveBox3D
| public virtual RemoveBox3D( | ) |
-
Removes a box3D operator in the view.
o SetBox3DOptions
| public virtual SetBox3DOptions( | const | iClippingType | =ClippingByBox, |
| const | iClippingMode | =Relimit) |
-
Sets parameters on a box operator.
- Parameters:
-
- iClippingType
- (box, slice or back clipping plane)
- iClippingMode
- ** NOT IMPLEMENTED **
- Returns:
-
- S_OK
- if operation succeeded.
- E_FAIL
- if a box does not exist on the view
o SetBox3D
| public virtual SetBox3D( | const | iPointA, |
| const | iPointB, |
| const | iPointC, |
| const | iPointD) |
-
Sets or create a clipping box (not available if a DMUBox already exists on the view).
The view may own only one box
- Parameters:
-
- iBox
- The box as xmin, xmax, ymin, ymax, zmin, zmax
- Returns:
-
- S_OK
- if operation succeeded.
- E_FAIL
- if A DMUBox exists on the view
o SetProjectionPlane
| public virtual SetProjectionPlane( | | iPlane) |
-
Sets the projection plane on the Generative View.
- Parameters:
-
- iPlane
- the CATMathPlane wich describes the projection plane of the view
o SetShowHidden
| public virtual SetShowHidden( | const | iShowHidden) |
-
Sets the generative view hidden line representation.
- Parameters:
-
- iShowHidden
-
TRUE = Hidden lines are show
FALSE = Hidden lines are not show
o SetShowSmooth
| public virtual SetShowSmooth( | const | iShowSmooth) |
-
Sets the generative view smooth edges representation.
- Parameters:
-
- iShowSmooth
-
TRUE = Smooth edges are show
FALSE = Smooth edges are not show
This object is included in the file: CATIDftGenView.h
If needed, your Imakefile.mk should include the module: CATDraftingInterfaces