Open CASCADE Technology 7.8.2.dev
TopoDS_CompSolid Class Reference

Describes a composite solid which. More...

#include <TopoDS_CompSolid.hxx>

Inheritance diagram for TopoDS_CompSolid:

Public Member Functions

 TopoDS_CompSolid ()
 Constructs an Undefined CompSolid.
 
- Public Member Functions inherited from TopoDS_Shape
 TopoDS_Shape ()
 Creates a NULL Shape referring to nothing.
 
template<class T2 >
 TopoDS_Shape (T2 &&theOther, typename std::enable_if< opencascade::std::is_base_of< TopoDS_Shape, T2 >::value >::type *=0)
 Generalized move constructor, accepting also sub-classes (TopoDS_Shape hierarchy declares only fake sub-classes with no extra fields).
 
template<class T2 >
std::enable_if< opencascade::std::is_base_of< TopoDS_Shape, T2 >::value, TopoDS_Shape >::type & operator= (T2 &&theOther)
 Generalized move assignment operator.
 
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 &theLoc, const Standard_Boolean theRaiseExc=Standard_True)
 Sets the shape local coordinate system.
 
TopoDS_Shape Located (const TopLoc_Location &theLoc, const Standard_Boolean theRaiseExc=Standard_True) 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 (TopAbs_Orientation theOrient)
 Sets the shape orientation.
 
TopoDS_Shape Oriented (TopAbs_Orientation theOrient) const
 Returns a shape similar to <me> with the orientation set to <Or>.
 
const Handle< TopoDS_TShape > & TShape () const
 Returns a handle to the actual shape implementation.
 
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 (Standard_Boolean theIsFree)
 Sets the free flag.
 
Standard_Boolean Locked () const
 Returns the locked flag.
 
void Locked (Standard_Boolean theIsLocked)
 Sets the locked flag.
 
Standard_Boolean Modified () const
 Returns the modification flag.
 
void Modified (Standard_Boolean theIsModified)
 Sets the modification flag.
 
Standard_Boolean Checked () const
 Returns the checked flag.
 
void Checked (Standard_Boolean theIsChecked)
 Sets the checked flag.
 
Standard_Boolean Orientable () const
 Returns the orientability flag.
 
void Orientable (const Standard_Boolean theIsOrientable)
 Sets the orientability flag.
 
Standard_Boolean Closed () const
 Returns the closedness flag.
 
void Closed (Standard_Boolean theIsClosed)
 Sets the closedness flag.
 
Standard_Boolean Infinite () const
 Returns the infinity flag.
 
void Infinite (Standard_Boolean theIsInfinite)
 Sets the infinity flag.
 
Standard_Boolean Convex () const
 Returns the convexness flag.
 
void Convex (Standard_Boolean theIsConvex)
 Sets the convexness flag.
 
void Move (const TopLoc_Location &thePosition, const Standard_Boolean theRaiseExc=Standard_True)
 Multiplies the Shape location by thePosition.
 
TopoDS_Shape Moved (const TopLoc_Location &thePosition, const Standard_Boolean theRaiseExc=Standard_True) const
 Returns a shape similar to <me> with a location multiplied by thePosition.
 
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 (TopAbs_Orientation theOrient)
 Updates the Shape Orientation by composition with theOrient, using the Compose method from the TopAbs package.
 
TopoDS_Shape Composed (TopAbs_Orientation theOrient) const
 Returns a shape similar to <me> with the orientation composed with theOrient, using the Compose method from the TopAbs package.
 
Standard_Integer NbChildren () const
 Returns the number of direct sub-shapes (children).
 
Standard_Boolean IsPartner (const TopoDS_Shape &theOther) 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 &theOther) 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 &theOther) 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 &theOther) const
 
Standard_Boolean IsNotEqual (const TopoDS_Shape &theOther) const
 Negation of the IsEqual method.
 
Standard_Boolean operator!= (const TopoDS_Shape &theOther) const
 
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 > &theTShape)
 
void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream.
 

Detailed Description

Describes a composite solid which.

  • references an underlying composite solid with the potential to be given a location and an orientation
  • has a location for the underlying composite solid, giving its placement in the local coordinate system
  • has an orientation for the underlying composite solid, in terms of its geometry (as opposed to orientation in relation to other shapes). Casts shape S to the more specialized return type, CompSolid.

Constructor & Destructor Documentation

◆ TopoDS_CompSolid()

TopoDS_CompSolid::TopoDS_CompSolid ( )
inline

Constructs an Undefined CompSolid.


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