Describes a compound which. More...
#include <TopoDS_Compound.hxx>
Inheritance diagram for TopoDS_Compound:
Public Member Functions | |
| TopoDS_Compound () | |
| Constructs an Undefined Compound. More... | |
 Public Member Functions inherited from TopoDS_Shape | |
| TopoDS_Shape () | |
| Creates a NULL Shape referring to nothing. More... | |
| 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). More... | |
| 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. More... | |
| 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. More... | |
| void | Nullify () |
| Destroys the reference to the underlying shape 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 &theLoc, const Standard_Boolean theRaiseExc=Standard_True) |
| Sets the shape local coordinate system. More... | |
| 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>. More... | |
| TopAbs_Orientation | Orientation () const |
| Returns the shape orientation. More... | |
| void | Orientation (TopAbs_Orientation theOrient) |
| Sets the shape orientation. More... | |
| TopoDS_Shape | Oriented (TopAbs_Orientation theOrient) const |
| Returns a shape similar to <me> with the orientation set to <Or>. More... | |
| const Handle< TopoDS_TShape > & | TShape () const |
| Returns a handle to the actual shape implementation. More... | |
| 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. More... | |
| 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 (const 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... | |
| void | Move (const TopLoc_Location &thePosition, const Standard_Boolean theRaiseExc=Standard_True) |
| Multiplies the Shape location by thePosition. More... | |
| 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. More... | |
| void | Reverse () |
| Reverses the orientation, using the Reverse method from the TopAbs package. More... | |
| TopoDS_Shape | Reversed () const |
| Returns a shape similar to <me> with the orientation reversed, using the Reverse method from the TopAbs package. More... | |
| void | Complement () |
| Complements the orientation, using the Complement method from the TopAbs package. More... | |
| TopoDS_Shape | Complemented () const |
| Returns a shape similar to <me> with the orientation complemented, using the Complement method from the TopAbs package. More... | |
| void | Compose (TopAbs_Orientation theOrient) |
| Updates the Shape Orientation by composition with theOrient, using the Compose method from the TopAbs package. More... | |
| 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. More... | |
| Standard_Integer | NbChildren () const |
| Returns the number of direct sub-shapes (children). More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| Standard_Boolean | operator== (const TopoDS_Shape &theOther) const |
| Standard_Boolean | IsNotEqual (const TopoDS_Shape &theOther) const |
| Negation of the IsEqual method. More... | |
| Standard_Boolean | operator!= (const TopoDS_Shape &theOther) const |
| Standard_Integer | HashCode (Standard_Integer theUpperBound) const |
| Returns a hashed value denoting <me>. This value is in the range [1, theUpperBound]. It is computed from the TShape and the Location. The Orientation is not used. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
Detailed Description
Describes a compound which.
- references an underlying compound with the potential to be given a location and an orientation
- has a location for the underlying compound, giving its placement in the local coordinate system
- has an orientation for the underlying compound, in terms of its geometry (as opposed to orientation in relation to other shapes). Casts shape S to the more specialized return type, Compound.
Constructor & Destructor Documentation
◆ TopoDS_Compound()
| TopoDS_Compound::TopoDS_Compound | ( | ) |
Constructs an Undefined Compound.
The documentation for this class was generated from the following file:
