A TShape is a topological structure describing a set of points in a 2D or 3D space. More...

#include <TopoDS_TShape.hxx>

Inheritance diagram for TopoDS_TShape:

[legend]

Public Types
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.

Public Member Functions
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.

virtual occ::handle< TopoDS_TShape >	EmptyCopy () const =0
	Returns a copy of the TShape with no sub-shapes.

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_Transient &	operator= (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_Transient *	This () 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.

Protected Member Functions
	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.

Additional Inherited Members
Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_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.

Detailed Description

A TShape is a topological structure describing a set of points in a 2D or 3D space.

A topological shape is a structure made from other shapes. This is a deferred class used to support topological objects.

TShapes are defined by their optional domain (geometry) and their components (other TShapes with Locations and Orientations). The components are stored in a list in the base class.

A TShape contains the following boolean flags:

Free : Free or Frozen.
Modified : Has been modified.
Checked : Has been checked.
Orientable : Can be oriented.
Closed : Is closed (note that only Wires and Shells may be closed).
Infinite : Is infinite.
Convex : Is convex.
Locked : Is locked against modifications.

Users have no direct access to the classes derived from TShape. They handle them with the classes derived from Shape.

Member Enumeration Documentation

◆ BitLayout

enum TopoDS_TShape::BitLayout : uint16_t

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.

Enumerator
Bits_ShapeType_Mask	bits 0-3: shape type mask
Bits_ShapeType_Shift	shift for shape type
Bit_Free	bit 4: free flag
Bit_Modified	bit 5: modified flag
Bit_Checked	bit 6: checked flag
Bit_Orientable	bit 7: orientable flag
Bit_Closed	bit 8: closed flag
Bit_Infinite	bit 9: infinite flag
Bit_Convex	bit 10: convex flag
Bit_Locked	bit 11: locked flag
Bits_Reserved	bits 12-15: reserved

Constructor & Destructor Documentation

◆ TopoDS_TShape()

TopoDS_TShape::TopoDS_TShape ( TopAbs_ShapeEnum theType )

inlineprotected

Constructs a TShape with the given shape type. Default flags: Free = true, Modified = true, Orientable = true.

Parameters

theType the shape type to embed in the state

Member Function Documentation

◆ Checked() [1/2]

bool TopoDS_TShape::Checked ( ) const

inline

Returns the checked flag.

◆ Checked() [2/2]

void TopoDS_TShape::Checked ( bool theIsChecked )

inline

Sets the checked flag.

◆ Closed() [1/2]

bool TopoDS_TShape::Closed ( ) const

inline

Returns the closedness flag.

◆ Closed() [2/2]

void TopoDS_TShape::Closed ( bool theIsClosed )

inline

Sets the closedness flag.

◆ Convex() [1/2]

bool TopoDS_TShape::Convex ( ) const

inline

Returns the convexness flag.

◆ Convex() [2/2]

void TopoDS_TShape::Convex ( bool theIsConvex )

inline

Sets the convexness flag.

◆ DumpJson()

virtual void TopoDS_TShape::DumpJson	(	Standard_OStream &	theOStream,
		int	theDepth = -1 ) const

virtual

Dumps the content of me into the stream.

Reimplemented in BRep_TEdge, BRep_TFace, and BRep_TVertex.

◆ EmptyCopy()

virtual occ::handle< TopoDS_TShape > TopoDS_TShape::EmptyCopy ( ) const

pure virtual

Returns a copy of the TShape with no sub-shapes.

Implemented in BRep_TEdge, BRep_TFace, BRep_TVertex, TopoDS_TCompound, TopoDS_TCompSolid, TopoDS_TEdge, TopoDS_TFace, TopoDS_TShell, TopoDS_TSolid, and TopoDS_TWire.

◆ Free() [1/2]

bool TopoDS_TShape::Free ( ) const

inline

Returns the free flag.

◆ Free() [2/2]

void TopoDS_TShape::Free ( bool theIsFree )

inline

Sets the free flag.

◆ Infinite() [1/2]

bool TopoDS_TShape::Infinite ( ) const

inline

Returns the infinity flag.

◆ Infinite() [2/2]

void TopoDS_TShape::Infinite ( bool theIsInfinite )

inline

Sets the infinity flag.

◆ Locked() [1/2]

bool TopoDS_TShape::Locked ( ) const

inline

Returns the locked flag.

◆ Locked() [2/2]

void TopoDS_TShape::Locked ( bool theIsLocked )

inline

Sets the locked flag.

◆ Modified() [1/2]

bool TopoDS_TShape::Modified ( ) const

inline

Returns the modification flag.

◆ Modified() [2/2]

void TopoDS_TShape::Modified ( bool theIsModified )

inline

Sets the modification flag.

◆ NbChildren()

int TopoDS_TShape::NbChildren ( ) const

inline

Returns the number of direct sub-shapes (children).

See also: TopoDS_Iterator for accessing sub-shapes

◆ Orientable() [1/2]

bool TopoDS_TShape::Orientable ( ) const

inline

Returns the orientability flag.

◆ Orientable() [2/2]

void TopoDS_TShape::Orientable ( bool theIsOrientable )

inline

Sets the orientability flag.

◆ setBit()

void TopoDS_TShape::setBit	(	uint16_t	theBit,
		bool	theIsOn )

inlineprotected

Set a bit flag.

Parameters

theBit	the bit to set
theIsOn	true to set, false to clear

◆ ShapeType()

TopAbs_ShapeEnum TopoDS_TShape::ShapeType ( ) const

inline

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.

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

TopoDS_TShape.hxx

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ BitLayout

Constructor & Destructor Documentation

◆ TopoDS_TShape()

Member Function Documentation

◆ Checked() [1/2]

◆ Checked() [2/2]

◆ Closed() [1/2]

◆ Closed() [2/2]

◆ Convex() [1/2]

◆ Convex() [2/2]

◆ DumpJson()

◆ EmptyCopy()

◆ Free() [1/2]

◆ Free() [2/2]

◆ Infinite() [1/2]

◆ Infinite() [2/2]

◆ Locked() [1/2]

◆ Locked() [2/2]

◆ Modified() [1/2]

◆ Modified() [2/2]

◆ NbChildren()

◆ Orientable() [1/2]

◆ Orientable() [2/2]

◆ setBit()

◆ ShapeType()