Open CASCADE Technology  7.4.0
Public Member Functions | Protected Member Functions

TopoDS_TShape Class Referenceabstract

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:
Inheritance graph
[legend]

Public Member Functions

Standard_Boolean Free () const
 Returns the free flag. More...
 
void Free (Standard_Boolean theIsFree)
 Sets the free flag. More...
 
Standard_Boolean Locked () const
 Returns the locked flag. More...
 
void Locked (Standard_Boolean theIsLocked)
 Sets the locked flag. More...
 
Standard_Boolean Modified () const
 Returns the modification flag. More...
 
void Modified (Standard_Boolean theIsModified)
 Sets the modification flag. More...
 
Standard_Boolean Checked () const
 Returns the checked flag. More...
 
void Checked (Standard_Boolean theIsChecked)
 Sets the checked flag. More...
 
Standard_Boolean Orientable () const
 Returns the orientability flag. More...
 
void Orientable (Standard_Boolean theIsOrientable)
 Sets the orientability flag. More...
 
Standard_Boolean Closed () const
 Returns the closedness flag. More...
 
void Closed (Standard_Boolean theIsClosed)
 Sets the closedness flag. More...
 
Standard_Boolean Infinite () const
 Returns the infinity flag. More...
 
void Infinite (Standard_Boolean theIsInfinite)
 Sets the infinity flag. More...
 
Standard_Boolean Convex () const
 Returns the convexness flag. More...
 
void Convex (Standard_Boolean theIsConvex)
 Sets the convexness flag. More...
 
virtual TopAbs_ShapeEnum ShapeType () const =0
 Returns the type as a term of the ShapeEnum enum : VERTEX, EDGE, WIRE, FACE, .... More...
 
virtual Handle< TopoDS_TShapeEmptyCopy () const =0
 Returns a copy of the TShape with no sub-shapes. More...
 
Standard_Integer NbChildren () const
 Returns the number of direct sub-shapes (children). More...
 
void DumpJson (Standard_OStream &theOStream, const Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean 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. More...
 
Standard_Boolean IsKind (const Standard_CString 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. More...
 
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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Protected Member Functions

 TopoDS_TShape ()
 Constructs an empty TShape. Free : True Modified : True Checked : False Orientable : True Closed : False Infinite : False Convex : False. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

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 of Shapes.

A TShape contains the following boolean flags :

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

Constructor & Destructor Documentation

◆ TopoDS_TShape()

TopoDS_TShape::TopoDS_TShape ( )
inlineprotected

Constructs an empty TShape. Free : True Modified : True Checked : False Orientable : True Closed : False Infinite : False Convex : False.

Member Function Documentation

◆ Checked() [1/2]

Standard_Boolean TopoDS_TShape::Checked ( ) const
inline

Returns the checked flag.

◆ Checked() [2/2]

void TopoDS_TShape::Checked ( Standard_Boolean  theIsChecked)
inline

Sets the checked flag.

◆ Closed() [1/2]

Standard_Boolean TopoDS_TShape::Closed ( ) const
inline

Returns the closedness flag.

◆ Closed() [2/2]

void TopoDS_TShape::Closed ( Standard_Boolean  theIsClosed)
inline

Sets the closedness flag.

◆ Convex() [1/2]

Standard_Boolean TopoDS_TShape::Convex ( ) const
inline

Returns the convexness flag.

◆ Convex() [2/2]

void TopoDS_TShape::Convex ( Standard_Boolean  theIsConvex)
inline

Sets the convexness flag.

◆ DumpJson()

void TopoDS_TShape::DumpJson ( Standard_OStream theOStream,
const Standard_Integer  theDepth = -1 
) const

Dumps the content of me into the stream.

◆ EmptyCopy()

virtual Handle< TopoDS_TShape > TopoDS_TShape::EmptyCopy ( ) const
pure virtual

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

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

◆ Free() [1/2]

Standard_Boolean TopoDS_TShape::Free ( ) const
inline

Returns the free flag.

◆ Free() [2/2]

void TopoDS_TShape::Free ( Standard_Boolean  theIsFree)
inline

Sets the free flag.

◆ Infinite() [1/2]

Standard_Boolean TopoDS_TShape::Infinite ( ) const
inline

Returns the infinity flag.

◆ Infinite() [2/2]

void TopoDS_TShape::Infinite ( Standard_Boolean  theIsInfinite)
inline

Sets the infinity flag.

◆ Locked() [1/2]

Standard_Boolean TopoDS_TShape::Locked ( ) const
inline

Returns the locked flag.

◆ Locked() [2/2]

void TopoDS_TShape::Locked ( Standard_Boolean  theIsLocked)
inline

Sets the locked flag.

◆ Modified() [1/2]

Standard_Boolean TopoDS_TShape::Modified ( ) const
inline

Returns the modification flag.

◆ Modified() [2/2]

void TopoDS_TShape::Modified ( Standard_Boolean  theIsModified)
inline

Sets the modification flag.

◆ NbChildren()

Standard_Integer TopoDS_TShape::NbChildren ( ) const
inline

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

See also
TopoDS_Iterator for accessing sub-shapes

◆ Orientable() [1/2]

Standard_Boolean TopoDS_TShape::Orientable ( ) const
inline

Returns the orientability flag.

◆ Orientable() [2/2]

void TopoDS_TShape::Orientable ( Standard_Boolean  theIsOrientable)
inline

Sets the orientability flag.

◆ ShapeType()

virtual TopAbs_ShapeEnum TopoDS_TShape::ShapeType ( ) const
pure virtual

Returns the type as a term of the ShapeEnum enum : VERTEX, EDGE, WIRE, FACE, ....

Implemented in TopoDS_TVertex, TopoDS_TFace, TopoDS_TSolid, TopoDS_TCompound, TopoDS_TCompSolid, TopoDS_TShell, TopoDS_TWire, and TopoDS_TEdge.


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