Open CASCADE Technology 6.6.0
Public Member Functions
TopoDS_Shape Class Reference

Describes a shape which
More...

#include <TopoDS_Shape.hxx>

Inheritance diagram for TopoDS_Shape:
Inheritance graph
[legend]

Public Member Functions

 TopoDS_Shape ()
 Creates a NULL Shape referring to nothing.

Standard_Boolean IsNull () const
 Returns true if this shape is null. In other words, it
references no underlying shape with the potential to
be given a location and an orientation.

void Nullify ()
 Destroys the reference to the underlying shape
stored in this shape. As a result, this shape becomes null.

const TopLoc_LocationLocation () const
 Returns the shape local coordinate system.

void Location (const TopLoc_Location &Loc)
 Sets the shape local coordinate system.

TopoDS_Shape Located (const TopLoc_Location &Loc) const
 Returns a shape similar to <me> with the local
coordinate system set to <Loc>.


TopAbs_Orientation Orientation () const
 Returns the shape orientation.


void Orientation (const TopAbs_Orientation Orient)
 Sets the shape orientation.

TopoDS_Shape Oriented (const TopAbs_Orientation Or) const
 Returns a shape similar to <me> with the
orientation set to <Or>.


const Handle_TopoDS_TShape & TShape () const
TopAbs_ShapeEnum ShapeType () const
 Returns the value of the TopAbs_ShapeEnum
enumeration that corresponds to this shape, for
example VERTEX, EDGE, and so on.
Exceptions
Standard_NullObject if this shape is null.

Standard_Boolean Free () const
 Returns the free flag.


void Free (const Standard_Boolean F)
 Sets the free flag.


Standard_Boolean Modified () const
 Returns the modification flag.


void Modified (const Standard_Boolean M)
 Sets the modification flag.


Standard_Boolean Checked () const
 Returns the checked flag.


void Checked (const Standard_Boolean C)
 Sets the checked flag.


Standard_Boolean Orientable () const
 Returns the orientability flag.


void Orientable (const Standard_Boolean C)
 Sets the orientability flag.


Standard_Boolean Closed () const
 Returns the closedness flag.


void Closed (const Standard_Boolean C)
 Sets the closedness flag.


Standard_Boolean Infinite () const
 Returns the infinity flag.


void Infinite (const Standard_Boolean C)
 Sets the infinity flag.


Standard_Boolean Convex () const
 Returns the convexness flag.


void Convex (const Standard_Boolean C)
 Sets the convexness flag.


void Move (const TopLoc_Location &position)
 Multiplies the Shape location by <position>.


TopoDS_Shape Moved (const TopLoc_Location &position) const
 Returns a shape similar to <me> with a location
multiplied by <position>.


void Reverse ()
 Reverses the orientation, using the Reverse method
from the TopAbs package.


TopoDS_Shape Reversed () const
 Returns a shape similar to <me> with the
orientation reversed, using the Reverse method
from the TopAbs package.


void Complement ()
 Complements the orientation, using the Complement
method from the TopAbs package.


TopoDS_Shape Complemented () const
 Returns a shape similar to <me> with the
orientation complemented, using the Complement
method from the TopAbs package.


void Compose (const TopAbs_Orientation Orient)
 Updates the Shape Orientation by composition with
<Orient>, using the Compose method from the TopAbs
package.


TopoDS_Shape Composed (const TopAbs_Orientation Orient) const
 Returns a shape similar to <me> with the
orientation composed with <Orient>, using the
Compose method from the TopAbs package.


Standard_Boolean IsPartner (const TopoDS_Shape &other) const
 Returns True if two shapes are partners, i.e. if
they share the same TShape. Locations and
Orientations may differ.


Standard_Boolean IsSame (const TopoDS_Shape &other) const
 Returns True if two shapes are same, i.e. if they
share the same TShape with the same Locations.
Orientations may differ.

Standard_Boolean IsEqual (const TopoDS_Shape &other) const
 Returns True if two shapes are equal, i.e. if they
share the same TShape with the same Locations and
Orientations.


Standard_Boolean operator== (const TopoDS_Shape &other) const
Standard_Boolean IsNotEqual (const TopoDS_Shape &other) const
 Negation of the IsEqual method.


Standard_Boolean operator!= (const TopoDS_Shape &other) const
Standard_Integer HashCode (const Standard_Integer Upper) const
 Returns a hashed value denoting <me>. This value
is in the range 1..<Upper>. It is computed from
the TShape and the Location. The Orientation is
not used.


void EmptyCopy ()
 Replace <me> by a new Shape with the same
Orientation and Location and a new TShape with the
same geometry and no sub-shapes.


TopoDS_Shape EmptyCopied () const
 Returns a new Shape with the same Orientation and
Location and a new TShape with the same geometry
and no sub-shapes.


void TShape (const Handle< TopoDS_TShape > &T)

Detailed Description


Constructor & Destructor Documentation

TopoDS_Shape::TopoDS_Shape ( )

Member Function Documentation

Standard_Boolean TopoDS_Shape::Checked ( ) const
void TopoDS_Shape::Checked ( const Standard_Boolean  C)
Standard_Boolean TopoDS_Shape::Closed ( ) const
void TopoDS_Shape::Closed ( const Standard_Boolean  C)
void TopoDS_Shape::Complement ( )
TopoDS_Shape TopoDS_Shape::Complemented ( ) const
void TopoDS_Shape::Compose ( const TopAbs_Orientation  Orient)
TopoDS_Shape TopoDS_Shape::Composed ( const TopAbs_Orientation  Orient) const
Standard_Boolean TopoDS_Shape::Convex ( ) const
void TopoDS_Shape::Convex ( const Standard_Boolean  C)
TopoDS_Shape TopoDS_Shape::EmptyCopied ( ) const
void TopoDS_Shape::EmptyCopy ( )
Standard_Boolean TopoDS_Shape::Free ( ) const
void TopoDS_Shape::Free ( const Standard_Boolean  F)
Standard_Integer TopoDS_Shape::HashCode ( const Standard_Integer  Upper) const
Standard_Boolean TopoDS_Shape::Infinite ( ) const
void TopoDS_Shape::Infinite ( const Standard_Boolean  C)
Standard_Boolean TopoDS_Shape::IsEqual ( const TopoDS_Shape other) const
Standard_Boolean TopoDS_Shape::IsNotEqual ( const TopoDS_Shape other) const
Standard_Boolean TopoDS_Shape::IsNull ( ) const
Standard_Boolean TopoDS_Shape::IsPartner ( const TopoDS_Shape other) const
Standard_Boolean TopoDS_Shape::IsSame ( const TopoDS_Shape other) const
TopoDS_Shape TopoDS_Shape::Located ( const TopLoc_Location Loc) const
void TopoDS_Shape::Location ( const TopLoc_Location Loc)
const TopLoc_Location& TopoDS_Shape::Location ( ) const
Standard_Boolean TopoDS_Shape::Modified ( ) const
void TopoDS_Shape::Modified ( const Standard_Boolean  M)
void TopoDS_Shape::Move ( const TopLoc_Location position)
TopoDS_Shape TopoDS_Shape::Moved ( const TopLoc_Location position) const
void TopoDS_Shape::Nullify ( )
Standard_Boolean TopoDS_Shape::operator!= ( const TopoDS_Shape other) const [inline]
Standard_Boolean TopoDS_Shape::operator== ( const TopoDS_Shape other) const [inline]
Standard_Boolean TopoDS_Shape::Orientable ( ) const
void TopoDS_Shape::Orientable ( const Standard_Boolean  C)
void TopoDS_Shape::Orientation ( const TopAbs_Orientation  Orient)
TopAbs_Orientation TopoDS_Shape::Orientation ( ) const
TopoDS_Shape TopoDS_Shape::Oriented ( const TopAbs_Orientation  Or) const
void TopoDS_Shape::Reverse ( )
TopoDS_Shape TopoDS_Shape::Reversed ( ) const
TopAbs_ShapeEnum TopoDS_Shape::ShapeType ( ) const
const Handle_TopoDS_TShape& TopoDS_Shape::TShape ( ) const
void TopoDS_Shape::TShape ( const Handle< TopoDS_TShape > &  T)

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines