Open CASCADE Technology Reference Manual 8.0.0
Loading...
Searching...
No Matches
Static Public Member Functions
TransferBRep Class Reference

This package gathers services to simply read files and convert them to Shapes from CasCade. IE. it can be used in conjunction with purely CasCade software. More...

#include <TransferBRep.hxx>

Static Public Member Functions

static TopoDS_Shape ShapeResult (const occ::handle< Transfer_Binder > &binder)
 Get the Shape recorded in a Binder If the Binder brings a multiple result, search for the Shape.
 
static TopoDS_Shape ShapeResult (const occ::handle< Transfer_TransientProcess > &TP, const occ::handle< Standard_Transient > &ent)
 Get the Shape recorded in a TransientProcess as result of the Transfer of an entity. I.E. in the binder bound to that Entity If no result or result not a single Shape, returns a Null Shape.
 
static void SetShapeResult (const occ::handle< Transfer_TransientProcess > &TP, const occ::handle< Standard_Transient > &ent, const TopoDS_Shape &result)
 Sets a Shape as a result for a starting entity <ent> (reverse of ShapeResult) It simply creates a ShapeBinder then binds it to the entity.
 
static occ::handle< NCollection_HSequence< TopoDS_Shape > > Shapes (const occ::handle< Transfer_TransientProcess > &TP, const bool rootsonly=true)
 Gets the Shapes recorded in a TransientProcess as result of a Transfer, considers roots only or all results according <rootsonly>, returns them as a HSequence.
 
static occ::handle< NCollection_HSequence< TopoDS_Shape > > Shapes (const occ::handle< Transfer_TransientProcess > &TP, const occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > &list)
 Gets the Shapes recorded in a TransientProcess as result of a Transfer, for a given list of starting entities, returns the shapes as a HSequence.
 
static TopAbs_Orientation ShapeState (const occ::handle< Transfer_FinderProcess > &FP, const TopoDS_Shape &shape)
 Returns a Status regarding a Shape in a FinderProcess.
 
static occ::handle< Transfer_BinderResultFromShape (const occ::handle< Transfer_FinderProcess > &FP, const TopoDS_Shape &shape)
 Returns the result (as a Binder) attached to a given Shape Null if none.
 
static occ::handle< Standard_TransientTransientFromShape (const occ::handle< Transfer_FinderProcess > &FP, const TopoDS_Shape &shape)
 Returns the result as pure Transient attached to a Shape first one if multiple result.
 
static void SetTransientFromShape (const occ::handle< Transfer_FinderProcess > &FP, const TopoDS_Shape &shape, const occ::handle< Standard_Transient > &result)
 Binds a Transient Result to a Shape in a FinderProcess (as first result if multiple : does not add it to existing one)
 
static occ::handle< TransferBRep_ShapeMapperShapeMapper (const occ::handle< Transfer_FinderProcess > &FP, const TopoDS_Shape &shape)
 Returns a ShapeMapper for a given Shape (location included) Either <shape> is already mapped, then its Mapper is returned Or it is not, then a new one is created then returned, BUT it is not mapped here (use Bind or FindElseBind to do this)
 
static void TransferResultInfo (const occ::handle< Transfer_TransientProcess > &TP, const occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > &EntityTypes, occ::handle< NCollection_HSequence< occ::handle< TransferBRep_TransferResultInfo > > > &InfoSeq)
 Fills sequence of TransferResultInfo for each type of entity given in the EntityTypes (entity are given as objects). Method IsKind applied to the entities in TP is used to compare with entities in EntityTypes. TopAbs_ShapeEnum).
 
static void TransferResultInfo (const occ::handle< Transfer_FinderProcess > &FP, const occ::handle< NCollection_HSequence< int > > &ShapeTypes, occ::handle< NCollection_HSequence< occ::handle< TransferBRep_TransferResultInfo > > > &InfoSeq)
 Fills sequence of TransferResultInfo for each type of shape given in the ShapeTypes (which are in fact considered as TopAbs_ShapeEnum). The Finders in the FP are considered as ShapeMappers.
 
static void PrintResultInfo (const occ::handle< Message_Printer > &Printer, const Message_Msg &Header, const occ::handle< TransferBRep_TransferResultInfo > &ResultInfo, const bool printEmpty=true)
 Prints the results of transfer to given priner with given header.
 
static Interface_CheckIterator BRepCheck (const TopoDS_Shape &shape, const int lev=1)
 Performs a heavy check by calling the Analyser from BRepCheck This tool computes a lot of information about integrity of a Shape. This method uses it and converts its internal result to a classic check-list. <lev> allows to get more information : 0 : BRepCheck only 1(D) + Curves/Surfaces not C0 ; 2 + SameParameter on Edges Warning : entities to which checks are bound are the Shapes themselves, embedded in ShapeMapper.
 
static Interface_CheckIterator ResultCheckList (const Interface_CheckIterator &chl, const occ::handle< Transfer_FinderProcess > &FP, const occ::handle< Interface_InterfaceModel > &model)
 Takes a starting CheckIterator which brings checks bound with starting objects (Shapes, Transient from an Imagine appli ...) and converts it to a CheckIterator in which checks are bound with results in an InterfaceModel Mapping is recorded in the FinderProcess Starting objects for which no individual result is recorded remain in their state.
 
static occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > Checked (const Interface_CheckIterator &chl, const bool alsoshapes=false)
 Returns the list of objects to which a non-empty Check is bound in a check-list. Objects are transients, they can then be either Imagine objects entities for an Interface Norm. <alsoshapes> commands Shapes to be returned too (as ShapeMapper), see also CheckedShapes.
 
static occ::handle< NCollection_HSequence< TopoDS_Shape > > CheckedShapes (const Interface_CheckIterator &chl)
 Returns the list of shapes to which a non-empty Check is bound in a check-list.
 
static Interface_CheckIterator CheckObject (const Interface_CheckIterator &chl, const occ::handle< Standard_Transient > &obj)
 Returns the check-list bound to a given object, generally none (if OK) or one check. <obj> can be, either a true Transient object or entity, or a ShapeMapper, in that case the Shape is considered.
 

Detailed Description

This package gathers services to simply read files and convert them to Shapes from CasCade. IE. it can be used in conjunction with purely CasCade software.

Member Function Documentation

◆ BRepCheck()

static Interface_CheckIterator TransferBRep::BRepCheck ( const TopoDS_Shape & shape,
const int lev = 1 )
static

Performs a heavy check by calling the Analyser from BRepCheck This tool computes a lot of information about integrity of a Shape. This method uses it and converts its internal result to a classic check-list. <lev> allows to get more information : 0 : BRepCheck only 1(D) + Curves/Surfaces not C0 ; 2 + SameParameter on Edges Warning : entities to which checks are bound are the Shapes themselves, embedded in ShapeMapper.

◆ Checked()

static occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > TransferBRep::Checked ( const Interface_CheckIterator & chl,
const bool alsoshapes = false )
static

Returns the list of objects to which a non-empty Check is bound in a check-list. Objects are transients, they can then be either Imagine objects entities for an Interface Norm. <alsoshapes> commands Shapes to be returned too (as ShapeMapper), see also CheckedShapes.

◆ CheckedShapes()

static occ::handle< NCollection_HSequence< TopoDS_Shape > > TransferBRep::CheckedShapes ( const Interface_CheckIterator & chl)
static

Returns the list of shapes to which a non-empty Check is bound in a check-list.

◆ CheckObject()

static Interface_CheckIterator TransferBRep::CheckObject ( const Interface_CheckIterator & chl,
const occ::handle< Standard_Transient > & obj )
static

Returns the check-list bound to a given object, generally none (if OK) or one check. <obj> can be, either a true Transient object or entity, or a ShapeMapper, in that case the Shape is considered.

◆ PrintResultInfo()

static void TransferBRep::PrintResultInfo ( const occ::handle< Message_Printer > & Printer,
const Message_Msg & Header,
const occ::handle< TransferBRep_TransferResultInfo > & ResultInfo,
const bool printEmpty = true )
static

Prints the results of transfer to given priner with given header.

◆ ResultCheckList()

static Interface_CheckIterator TransferBRep::ResultCheckList ( const Interface_CheckIterator & chl,
const occ::handle< Transfer_FinderProcess > & FP,
const occ::handle< Interface_InterfaceModel > & model )
static

Takes a starting CheckIterator which brings checks bound with starting objects (Shapes, Transient from an Imagine appli ...) and converts it to a CheckIterator in which checks are bound with results in an InterfaceModel Mapping is recorded in the FinderProcess Starting objects for which no individual result is recorded remain in their state.

◆ ResultFromShape()

static occ::handle< Transfer_Binder > TransferBRep::ResultFromShape ( const occ::handle< Transfer_FinderProcess > & FP,
const TopoDS_Shape & shape )
static

Returns the result (as a Binder) attached to a given Shape Null if none.

◆ SetShapeResult()

static void TransferBRep::SetShapeResult ( const occ::handle< Transfer_TransientProcess > & TP,
const occ::handle< Standard_Transient > & ent,
const TopoDS_Shape & result )
static

Sets a Shape as a result for a starting entity <ent> (reverse of ShapeResult) It simply creates a ShapeBinder then binds it to the entity.

◆ SetTransientFromShape()

static void TransferBRep::SetTransientFromShape ( const occ::handle< Transfer_FinderProcess > & FP,
const TopoDS_Shape & shape,
const occ::handle< Standard_Transient > & result )
static

Binds a Transient Result to a Shape in a FinderProcess (as first result if multiple : does not add it to existing one)

◆ ShapeMapper()

static occ::handle< TransferBRep_ShapeMapper > TransferBRep::ShapeMapper ( const occ::handle< Transfer_FinderProcess > & FP,
const TopoDS_Shape & shape )
static

Returns a ShapeMapper for a given Shape (location included) Either <shape> is already mapped, then its Mapper is returned Or it is not, then a new one is created then returned, BUT it is not mapped here (use Bind or FindElseBind to do this)

◆ ShapeResult() [1/2]

static TopoDS_Shape TransferBRep::ShapeResult ( const occ::handle< Transfer_Binder > & binder)
static

Get the Shape recorded in a Binder If the Binder brings a multiple result, search for the Shape.

◆ ShapeResult() [2/2]

static TopoDS_Shape TransferBRep::ShapeResult ( const occ::handle< Transfer_TransientProcess > & TP,
const occ::handle< Standard_Transient > & ent )
static

Get the Shape recorded in a TransientProcess as result of the Transfer of an entity. I.E. in the binder bound to that Entity If no result or result not a single Shape, returns a Null Shape.

◆ Shapes() [1/2]

static occ::handle< NCollection_HSequence< TopoDS_Shape > > TransferBRep::Shapes ( const occ::handle< Transfer_TransientProcess > & TP,
const bool rootsonly = true )
static

Gets the Shapes recorded in a TransientProcess as result of a Transfer, considers roots only or all results according <rootsonly>, returns them as a HSequence.

◆ Shapes() [2/2]

Gets the Shapes recorded in a TransientProcess as result of a Transfer, for a given list of starting entities, returns the shapes as a HSequence.

◆ ShapeState()

static TopAbs_Orientation TransferBRep::ShapeState ( const occ::handle< Transfer_FinderProcess > & FP,
const TopoDS_Shape & shape )
static

Returns a Status regarding a Shape in a FinderProcess.

  • FORWARD means bound with SAME Orientation
  • REVERSED means bound with REVERSE Orientation
  • EXTERNAL means NOT BOUND
  • INTERNAL is not used

◆ TransferResultInfo() [1/2]

static void TransferBRep::TransferResultInfo ( const occ::handle< Transfer_FinderProcess > & FP,
const occ::handle< NCollection_HSequence< int > > & ShapeTypes,
occ::handle< NCollection_HSequence< occ::handle< TransferBRep_TransferResultInfo > > > & InfoSeq )
static

Fills sequence of TransferResultInfo for each type of shape given in the ShapeTypes (which are in fact considered as TopAbs_ShapeEnum). The Finders in the FP are considered as ShapeMappers.

◆ TransferResultInfo() [2/2]

static void TransferBRep::TransferResultInfo ( const occ::handle< Transfer_TransientProcess > & TP,
const occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > & EntityTypes,
occ::handle< NCollection_HSequence< occ::handle< TransferBRep_TransferResultInfo > > > & InfoSeq )
static

Fills sequence of TransferResultInfo for each type of entity given in the EntityTypes (entity are given as objects). Method IsKind applied to the entities in TP is used to compare with entities in EntityTypes. TopAbs_ShapeEnum).

◆ TransientFromShape()

static occ::handle< Standard_Transient > TransferBRep::TransientFromShape ( const occ::handle< Transfer_FinderProcess > & FP,
const TopoDS_Shape & shape )
static

Returns the result as pure Transient attached to a Shape first one if multiple result.


The documentation for this class was generated from the following file: