Describes a shape which
More...

#include <TopoDS_Shape.hxx>

Inheritance diagram for TopoDS_Shape:

[legend]

Public Member Functions
	TopoDS_Shape ()
	Creates a NULL Shape referring to nothing. More...

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

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

const TopLoc_Location &	Location () const
	Returns the shape local coordinate system. More...

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

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

TopAbs_Orientation	Orientation () const
	Returns the shape orientation. <br> More...

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

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

const Handle_TopoDS_TShape &	TShape () const

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

Standard_Boolean	Free () const
	Returns the free flag. <br> More...

void	Free (const Standard_Boolean F)
	Sets the free flag. <br> More...

Standard_Boolean	Modified () const
	Returns the modification flag. <br> More...

void	Modified (const Standard_Boolean M)
	Sets the modification flag. <br> More...

Standard_Boolean	Checked () const
	Returns the checked flag. <br> More...

void	Checked (const Standard_Boolean C)
	Sets the checked flag. <br> More...

Standard_Boolean	Orientable () const
	Returns the orientability flag. <br> More...

void	Orientable (const Standard_Boolean C)
	Sets the orientability flag. <br> More...

Standard_Boolean	Closed () const
	Returns the closedness flag. <br> More...

void	Closed (const Standard_Boolean C)
	Sets the closedness flag. <br> More...

Standard_Boolean	Infinite () const
	Returns the infinity flag. <br> More...

void	Infinite (const Standard_Boolean C)
	Sets the infinity flag. <br> More...

Standard_Boolean	Convex () const
	Returns the convexness flag. <br> More...

void	Convex (const Standard_Boolean C)
	Sets the convexness flag. <br> More...

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

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

void	Reverse ()
	Reverses the orientation, using the Reverse method <br> from the TopAbs package. <br> More...

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

void	Complement ()
	Complements the orientation, using the Complement <br> method from the TopAbs package. <br> More...

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

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

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

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

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. More...

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

Standard_Boolean	operator== (const TopoDS_Shape &other) const

Standard_Boolean	IsNotEqual (const TopoDS_Shape &other) const
	Negation of the IsEqual method. <br> More...

Standard_Boolean	operator!= (const TopoDS_Shape &other) const

Standard_Integer	HashCode (const Standard_Integer Upper) const
	Returns a hashed value denoting <me>. This value <br> is in the range 1..<Upper>. It is computed from <br> the TShape and the Location. The Orientation is <br> not used. <br> More...

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

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

void	TShape (const Handle< TopoDS_TShape > &T)

Detailed Description

Describes a shape which

references an underlying shape with the potential
to be given a location and an orientation
has a location for the underlying shape, giving its
placement in the local coordinate system
has an orientation for the underlying shape, in
terms of its geometry (as opposed to orientation in
relation to other shapes).
Note: A Shape is empty if it references an underlying
shape which has an empty list of shapes.

Constructor & Destructor Documentation

TopoDS_Shape::TopoDS_Shape ( )

Creates a NULL Shape referring to nothing.

Member Function Documentation

Standard_Boolean TopoDS_Shape::Checked ( ) const

 Returns the checked flag. <br>

void TopoDS_Shape::Checked ( const Standard_Boolean C )

 Sets the checked flag. <br>

Standard_Boolean TopoDS_Shape::Closed ( ) const

 Returns the closedness flag. <br>

void TopoDS_Shape::Closed ( const Standard_Boolean C )

 Sets the closedness flag. <br>

void TopoDS_Shape::Complement ( )

 Complements the orientation, using the  Complement <br>
     method from the TopAbs package. <br>

TopoDS_Shape TopoDS_Shape::Complemented ( ) const

 Returns  a   shape  similar  to   <me>   with  the <br>
     orientation complemented,  using   the  Complement <br>
     method from the TopAbs package. <br>

void TopoDS_Shape::Compose ( const TopAbs_Orientation Orient )

 Updates the  Shape Orientation by composition with <br>
     <Orient>, using the Compose method from the TopAbs <br>
     package. <br>

TopoDS_Shape TopoDS_Shape::Composed ( const TopAbs_Orientation Orient ) const

 Returns  a  shape   similar   to  <me>   with  the <br>
     orientation  composed  with <Orient>,   using  the <br>
     Compose method from the TopAbs package. <br>

Standard_Boolean TopoDS_Shape::Convex ( ) const

 Returns the convexness flag. <br>

void TopoDS_Shape::Convex ( const Standard_Boolean C )

 Sets the convexness flag. <br>

TopoDS_Shape TopoDS_Shape::EmptyCopied ( ) const

 Returns a new Shape with the  same Orientation and <br>
     Location and  a new TShape  with the same geometry <br>
     and no sub-shapes. <br>

void TopoDS_Shape::EmptyCopy ( )

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

Standard_Boolean TopoDS_Shape::Free ( ) const

 Returns the free flag. <br>

void TopoDS_Shape::Free ( const Standard_Boolean F )

 Sets the free flag. <br>

Standard_Integer TopoDS_Shape::HashCode ( const Standard_Integer Upper ) const

 Returns a hashed value  denoting <me>.  This value <br>
     is in the range  1..<Upper>.  It is  computed from <br>
     the  TShape  and the  Location. The Orientation is <br>
     not used. <br>

Standard_Boolean TopoDS_Shape::Infinite ( ) const

 Returns the infinity flag. <br>

void TopoDS_Shape::Infinite ( const Standard_Boolean C )

 Sets the infinity flag. <br>

Standard_Boolean TopoDS_Shape::IsEqual ( const TopoDS_Shape & other ) const

 Returns True if two shapes are equal, i.e. if they <br>
     share the same TShape with  the same Locations and <br>
     Orientations. <br>

Standard_Boolean TopoDS_Shape::IsNotEqual ( const TopoDS_Shape & other ) const

 Negation of the IsEqual method. <br>

Standard_Boolean TopoDS_Shape::IsNull ( ) const

 Returns true if this shape is null. In other words, it <br>

references no underlying shape with the potential to
be given a location and an orientation.

Standard_Boolean TopoDS_Shape::IsPartner ( const TopoDS_Shape & other ) const

 Returns True if two shapes  are partners, i.e.  if <br>
     they   share   the   same  TShape.  Locations  and <br>
     Orientations may differ. <br>

Standard_Boolean TopoDS_Shape::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.

TopoDS_Shape TopoDS_Shape::Located ( const TopLoc_Location & Loc ) const

 Returns a  shape  similar to <me> with   the local <br>
     coordinate system set to <Loc>. <br>

const TopLoc_Location& TopoDS_Shape::Location ( ) const

Returns the shape local coordinate system.

void TopoDS_Shape::Location ( const TopLoc_Location & Loc )

Sets the shape local coordinate system.

Standard_Boolean TopoDS_Shape::Modified ( ) const

 Returns the modification flag. <br>

void TopoDS_Shape::Modified ( const Standard_Boolean M )

 Sets the modification flag. <br>

void TopoDS_Shape::Move ( const TopLoc_Location & position )

 Multiplies the Shape location by <position>. <br>

TopoDS_Shape TopoDS_Shape::Moved ( const TopLoc_Location & position ) const

 Returns  a shape similar  to  <me> with a location <br>
     multiplied  by <position>. <br>

void TopoDS_Shape::Nullify ( )

 Destroys the reference to the underlying shape <br>

stored in this shape. As a result, this shape becomes null.

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

 Returns the orientability flag. <br>

void TopoDS_Shape::Orientable ( const Standard_Boolean C )

 Sets the orientability flag. <br>

TopAbs_Orientation TopoDS_Shape::Orientation ( ) const

 Returns the shape orientation. <br>

void TopoDS_Shape::Orientation ( const TopAbs_Orientation Orient )

Sets the shape orientation.

TopoDS_Shape TopoDS_Shape::Oriented ( const TopAbs_Orientation Or ) const

 Returns  a    shape  similar  to  <me>   with  the <br>
     orientation set to <Or>. <br>

void TopoDS_Shape::Reverse ( )

 Reverses the orientation, using the Reverse method <br>
     from the TopAbs package. <br>

TopoDS_Shape TopoDS_Shape::Reversed ( ) const

 Returns    a shape  similar    to  <me>  with  the <br>
     orientation  reversed, using  the   Reverse method <br>
     from the TopAbs package. <br>

TopAbs_ShapeEnum TopoDS_Shape::ShapeType ( ) const

 Returns the value of the TopAbs_ShapeEnum <br>

enumeration that corresponds to this shape, for
example VERTEX, EDGE, and so on.
Exceptions
Standard_NullObject if this shape is null.

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:

TopoDS_Shape.hxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation