#include <DbJoinEntityPE.h>
Public Member Functions | |
| ODRX_DECLARE_MEMBERS (OdDbJoinEntityPE) | |
| virtual OdResult | joinEntities (OdDbEntityPtr primaryEntity, const OdDbEntityPtrArray &otherEntities, OdGeIntArray &joinedEntityIndices) const =0 |
| virtual OdResult | joinEntity (OdDbEntityPtr primaryEntity, OdDbEntityPtr secondaryEntity) const |
 Public Member Functions inherited from OdRxObject | |
| ODRX_HEAP_OPERATORS () | |
| OdRxObject () | |
| virtual | ~OdRxObject () |
| virtual OdRxObject * | queryX (const OdRxClass *pClass) const |
| virtual OdRxObject * | x (const OdRxClass *pClass) const |
| virtual OdRxClass * | isA () const |
| virtual void | addRef ()=0 |
| virtual void | release ()=0 |
| virtual long | numRefs () const |
| bool | isKindOf (const OdRxClass *pClass) const |
| virtual OdRxObjectPtr | clone () const |
| virtual void | copyFrom (const OdRxObject *pSource) |
| virtual OdRx::Ordering | comparedTo (const OdRxObject *pOther) const |
| virtual bool | isEqualTo (const OdRxObject *pOther) const |
Additional Inherited Members | |
| Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
Detailed Description
This abstract class declares the base JOIN functionality for entities that allows searching intersections between them and uniting them in a single curve using the protocol extension mechanism.
Corresponding C++ library: TD_Db
<group Join_Classes>
Definition at line 38 of file DbJoinEntityPE.h.
Member Function Documentation
◆ joinEntities()
|
pure virtual |
This pure virtual method that must be implemented in derived class to provide the join operation between entities. Returns eOk if the join is successful, otherwise, eInvalidInput.
- Parameters
-
primaryEntity [in] Smart pointer to the primary entity that should be updated using parameters of other entities joined to it, when it is possible. otherEntities [in] Array of smart pointers to other entities that are joined to the primary entity. joinedEntityIndices [out] Reference to an array of entity indices from the array of other entities (second argument) that were joined successfully.
◆ joinEntity()
|
virtual |
This virtual method that must be implemented in derived class to provide the join operation of two supported entities. Returns eOk if the join is successful, otherwise, eInvalidInput. Some implementations can require the same type for primary and secondary entities.
- Parameters
-
primaryEntity [in] Smart pointer to the primary entity that should be updated using parameters of the secondary entity joined to it, when it is possible. secondaryEntity [in] Smart pointer to the secondary entity that represents own parameters for the primary entity joined to it.
◆ ODRX_DECLARE_MEMBERS()
| OdDbJoinEntityPE::ODRX_DECLARE_MEMBERS | ( | OdDbJoinEntityPE | ) |
The documentation for this class was generated from the following file: