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

A TCompound is an all-purpose set of Shapes. More...

#include <TopoDS_TCompound.hxx>

Inheritance diagram for TopoDS_TCompound:
Inheritance graph
[legend]

Public Member Functions

 TopoDS_TCompound ()
 Creates an empty TCompound.
 
occ::handle< TopoDS_TShapeEmptyCopy () const override
 Returns an empty TCompound.
 
- Public Member Functions inherited from TopoDS_TShape
bool Free () const
 Returns the free flag.
 
void Free (bool theIsFree)
 Sets the free flag.
 
bool Locked () const
 Returns the locked flag.
 
void Locked (bool theIsLocked)
 Sets the locked flag.
 
bool Modified () const
 Returns the modification flag.
 
void Modified (bool theIsModified)
 Sets the modification flag.
 
bool Checked () const
 Returns the checked flag.
 
void Checked (bool theIsChecked)
 Sets the checked flag.
 
bool Orientable () const
 Returns the orientability flag.
 
void Orientable (bool theIsOrientable)
 Sets the orientability flag.
 
bool Closed () const
 Returns the closedness flag.
 
void Closed (bool theIsClosed)
 Sets the closedness flag.
 
bool Infinite () const
 Returns the infinity flag.
 
void Infinite (bool theIsInfinite)
 Sets the infinity flag.
 
bool Convex () const
 Returns the convexness flag.
 
void Convex (bool theIsConvex)
 Sets the convexness flag.
 
TopAbs_ShapeEnum ShapeType () const
 Returns the type as a term of the ShapeEnum enum: VERTEX, EDGE, WIRE, FACE, SHELL, SOLID, COMPSOLID, COMPOUND. The type is embedded in the lower 4 bits of the state.
 
int NbChildren () const
 Returns the number of direct sub-shapes (children).
 
virtual void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
 Dumps the content of me into the stream.
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor.
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing.
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter.
 
virtual ~Standard_Transient ()=default
 Destructor must be virtual.
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object.
 
bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type.
 
bool IsInstance (const char *const theTypeName) const
 Returns a true value if this is an instance of TypeName.
 
bool IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
 
bool IsKind (const char *const theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
 
int GetRefCount () const noexcept
 Get the reference counter of this object.
 
void IncrementRefCounter () noexcept
 Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
 
int DecrementRefCounter () noexcept
 Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
 
virtual void Delete () const
 Memory deallocator for transient classes.
 

Additional Inherited Members

- Public Types inherited from TopoDS_TShape
enum  BitLayout : uint16_t {
  Bits_ShapeType_Mask = 0x000F , Bits_ShapeType_Shift = 0 , Bit_Free = 0x0010 , Bit_Modified = 0x0020 ,
  Bit_Checked = 0x0040 , Bit_Orientable = 0x0080 , Bit_Closed = 0x0100 , Bit_Infinite = 0x0200 ,
  Bit_Convex = 0x0400 , Bit_Locked = 0x0800 , Bits_Reserved = 0xF000
}
 Bit layout for compact state storage. Bits 0-3 store the TopAbs_ShapeEnum value (0-8). Bits 4-11 store boolean flags. Bits 12-15 are reserved for future use. More...
 
- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object.
 
- Static Public Member Functions inherited from Standard_Transient
static constexpr const charget_type_name ()
 Returns a type descriptor about this object.
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class.
 
- Protected Member Functions inherited from TopoDS_TShape
 TopoDS_TShape (TopAbs_ShapeEnum theType)
 Constructs a TShape with the given shape type. Default flags: Free = true, Modified = true, Orientable = true.
 
void setBit (uint16_t theBit, bool theIsOn)
 Set a bit flag.
 

Detailed Description

A TCompound is an all-purpose set of Shapes.

Constructor & Destructor Documentation

◆ TopoDS_TCompound()

TopoDS_TCompound::TopoDS_TCompound ( )
inline

Creates an empty TCompound.

Member Function Documentation

◆ EmptyCopy()

occ::handle< TopoDS_TShape > TopoDS_TCompound::EmptyCopy ( ) const
overridevirtual

Returns an empty TCompound.

Implements TopoDS_TShape.


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