All Frameworks Class Hierarchy This Framework Previous Next Indexes
TopologicalOperators Class CATTopExtrude
Mathematics.CATCGMVirtual
|
+---GeometricObjects.CATCGMOperator
|
+---NewTopologicalObjects.CATTopOperator
|
+---CATTopExtrude
Usage: you must use this class as is. You should never derive it.
public class CATTopExtrude
Base class for of all the topological operators doing extrusions.
Extrusion operators deriving
from this base class are used to build a prism, to revolve a profile about an axis
or to sweep a profile along a guide.
In addition to the extrusion creation, these operators provide the capability
to use a Boolean operation between a body (called trimming body), and the
created extrusion. To obtain such result, use the SetOperation
and SetTrim methods. In this case, GetResult returns the
created extrusion limited by the trimming body, while GetBooleanResult returns the result of
the Boolean operation between the trimming body and the extrusion.
Constructor and Destructor Index
- o
~CATTopExtrude()
- Destructor.
Method Index
- o
CheckOperands(CATLONG32&,CATError**&)
- Checks the consistency of the input operands.
- o
GetBooleanJournal()
- Returns a pointer to the topological Boolean journal dedicated to
this CATTopExtrude.
- o
GetBooleanResult()
- Returns a pointer to the body resulting from the Boolean operation between the extrusion and a trimming body.
- o
GetFreezeMode()
- Returns the mode in which the resulting body is created.
- o
IsResultInvariant()
- Tests whether the trimming body is touched by the Boolean operation.
- o
SetFreezeMode(CATBodyFreezeMode)
- Defines the state of the resulting body.
- o
SetOperation(CATTopBooleanType)
- Asks for a Boolean operation between the extruded body and another (called trimming) body.
- o
SetProfileClosure()
- Asks for the closure of the profile on a given body.
- o
SetRelimitationMode(short)
-
- o
SetResultMode(CATBoolean)
- Defines the type of result to be output for this
CATTopExtrude operator.
- o
SetSimplification(CATBoolean)
- Defines the simplication mode.
- o
SetTrim(CATBody*)
- Defines the triming body.
Constructor and Destructor
o ~CATTopExtrude
public virtual ~CATTopExtrude( | ) |
-
Destructor.
Methods
o CheckOperands
-
Checks the consistency of the input operands.
- Parameters:
-
- ioNbError
- The number of detected problems.
- oErrors
- The array of the pointers to the detected errors.
To delete by the caller, as well as the created errors.
- Returns:
- The result of the test.
Legal values 0 if a problem is detected, 1 otherwise.
o GetBooleanJournal
-
Returns a pointer to the topological Boolean journal dedicated to
this CATTopExtrude.
The journal only contains the items relative to the Boolean operation. Available
if SetResultMode(CATBoolean(1)) has been invoked.
- Returns:
- The pointer to the topological journal.
o GetBooleanResult
-
Returns a pointer to the body resulting from the Boolean operation between the extrusion and a trimming body.
Available if SetResultMode(CATBoolean(1)) has been invoked.
- Returns:
- The pointer to the created body.
If you do not want to keep this body,
use the
CATICGMContainer.Remove method to remove it from the geometric factory, after the operator deletion.
o GetFreezeMode
-
Returns the mode in which the resulting body is created.
- Returns:
- The state of the resulting body.
o IsResultInvariant
-
Tests whether the trimming body is touched by the Boolean operation.
- Returns:
- The result of the test.
Legal values: TRUE if it is touched, FALSE otherwise.
o SetFreezeMode
-
Defines the state of the resulting body.
- Parameters:
-
- iOnOrOff
- The state of the resulting body.
o SetOperation
-
Asks for a Boolean operation between the extruded body and another (called trimming) body.
- Parameters:
-
- iBoolType
- The type of Boolean operation to perform after the extrusion. By default,
no Boolean operation is done.
o SetProfileClosure
public virtual void SetProfileClosure( | )= 0 |
-
Asks for the closure of the profile on a given body.
The SetTrim method must then be called to define the triming body.
o SetRelimitationMode
public void SetRelimitationMode( | short | iMode | = 2) |
-
o SetResultMode
public virtual void SetResultMode( | CATBoolean | iBothResultRequired | =CATBoolean(0)) = 0 |
-
Defines the type of result to be output for this
CATTopExtrude operator.
- Parameters:
-
- iBothResultRequired
- The type of result.
- CATBoolean(0)
- GetResult only returns the relimitated shape
- CATBoolean(1)
-
- GetResult returns the relimitated shape
- GetBooleanResult returns the result of the Boolean operation
between the relimited shape and the trimming body.
o SetSimplification
public void SetSimplification( | CATBoolean | iSimplify | = CATBoolean(1)) |
-
Defines the simplication mode.
- Parameters:
-
- iSimplify
- The simplication mode.
Legal values: CATBoolean(1) to simplify as much as possible the faces of the
resulting body, CATBoolean(0) otherwise. By default, no simplication is done.
o SetTrim
public virtual void SetTrim( | CATBody* | iTrimBody | =NULL) = 0 |
-
Defines the triming body.
The trimming body defines the body on which the profil must be closed.
Moreover, it defines the body used in the Boolean operation, if any.
Hence, this method must be called after either a SetProfileClosure,
or a SetOperation call. If both are invoked, only one trimming body
can be set.
- Parameters:
-
- iTrimBody
- The pointer to the trimming body.
This object is included in the file: CATTopExtrude.h
If needed, your Imakefile.mk should include the module: CATTopologicalOperators