All Frameworks  Class Hierarchy  This Framework  Indexes   

NewTopologicalObjects Class CATTopRelimitByVolume

Usage: you must use this class as is. You should never derive it.


public class CATTopRelimitByVolume

Operator to trim a shell or a wire by a volume.
The generated result is made up of the portions of the input shell or wire which are inside or outside the input volume.
The body to be trimmed can be a multi-domain body. The domains making up the input body do not have necessarily to be of the same type. For example, the input body can contain a mixture of shells and lumps.
All the cells of the input body are trimmed by the volume and the portions to be kept are to be specifed by using the SetSelectionType method. Resulting sub-elements can be merged.

The CATTopRelimitByVolume operator is not streamable.

The CATTopRelimitByVolume operator is a multi-run operator:
the methods to set parameters as well as the Run and GetResult methods can be called several times from the same operator.

Parameters:
iFactory - A pointer to the factory of the resulting body.
iTopData - A pointer to the topological data.
iBodyToRelimit - A pointer to the body to be trimmed or relimited.
iSolidBody - A pointer to the solid used as trimming object.
Returns:
[out, IUnknown#Release]


Constructor and Destructor Index


o ~CATTopRelimitByVolume()

Method Index


o GetResult(CATCGMJournalList*)
Retrieves the trimmed result.
o GetSelectionType()
Retrieves the type of selection (inside, outside or boundary)
o Run()
Runs the operator.
o SetSelectionType(CATLONG32)
Specifies the portions of the input body to be kept.

Enumerated Type Index


o SelectionType

Constructor and Destructor


o ~CATTopRelimitByVolume
public virtual ~CATTopRelimitByVolume()

Methods


o GetResult
public virtual GetResult( ioJournal)
Retrieves the trimmed result.
Parameters:
ioJournal
The journal of operations
Returns:
The generated result.
o GetSelectionType
public virtual GetSelectionType()
Retrieves the type of selection (inside, outside or boundary)
Returns:
  • 0 - no result is generated
  • 1 - the skin which is inside the volume is kept
  • 2 - the skin which is outside the volume is kept
  • 3 - all the sub-elements are kept
  • 4 - the skin which is on the volume boundary is kept
o Run
public virtual Run()
Runs the operator.
o SetSelectionType
public virtual SetSelectionType( iSelectionType)
Specifies the portions of the input body to be kept.
Parameters:
  • 0 - no result is generated
  • 1 - the skin which is inside the volume is kept
  • 2 - the skin which is outside the volume is kept
  • 3 - all the sub-elements are kept
  • 4 - the skin which is on the volume boundary is kept

Enumerated Types


o SelectionType
enum SelectionType {
  None,
  InsideVolume,
  OutsideVolume,
  OnVolumeBoundary
}

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

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