TopoDS_Wire Class Reference

Describes a wire which. More...

#include <TopoDS_Wire.hxx>

Inheritance diagram for TopoDS_Wire:

Public Member Functions
	TopoDS_Wire ()=default
	Undefined Wire.
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 *=nullptr)
	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.
bool	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_Location &	Location () const
	Returns the shape local coordinate system.
void	Location (const TopLoc_Location &theLoc, const bool theRaiseExc=false)
	Sets the shape local coordinate system.
TopoDS_Shape	Located (const TopLoc_Location &theLoc, const bool theRaiseExc=false) 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 occ::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.
bool	Free () const
	Returns the free flag.
void	Free (bool theIsFree)
	Sets the free flag.
bool	Locked () const
	Returns the locked flag.
void	Locked (bool theIsLocked)
	Sets the locked flag.
bool	Modified () const
	Returns the modification flag.
void	Modified (bool theIsModified)
	Sets the modification flag.
bool	Checked () const
	Returns the checked flag.
void	Checked (bool theIsChecked)
	Sets the checked flag.
bool	Orientable () const
	Returns the orientability flag.
void	Orientable (const bool theIsOrientable)
	Sets the orientability flag.
bool	Closed () const
	Returns the closedness flag.
void	Closed (bool theIsClosed)
	Sets the closedness flag.
bool	Infinite () const
	Returns the infinity flag.
void	Infinite (bool theIsInfinite)
	Sets the infinity flag.
bool	Convex () const
	Returns the convexness flag.
void	Convex (bool theIsConvex)
	Sets the convexness flag.
void	Move (const TopLoc_Location &thePosition, const bool theRaiseExc=false)
	Multiplies the Shape location by thePosition.
TopoDS_Shape	Moved (const TopLoc_Location &thePosition, const bool theRaiseExc=false) 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.
int	NbChildren () const
	Returns the number of direct sub-shapes (children).
bool	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.
bool	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.
bool	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.
bool	operator== (const TopoDS_Shape &theOther) const
bool	IsNotEqual (const TopoDS_Shape &theOther) const
	Negation of the IsEqual method.
bool	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 occ::handle< TopoDS_TShape > &theTShape)
void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
	Dumps the content of me into the stream.

Additional Inherited Members
Protected Member Functions inherited from TopoDS_Shape
void	validateTransformation (const gp_Trsf &theTrsf) const
	Checks if the transformation contains scaling or negative values. Raises an exception if the transformation is invalid.

Detailed Description

Describes a wire which.

• references an underlying wire with the potential to be given a location and an orientation
• has a location for the underlying wire, giving its placement in the local coordinate system
• has an orientation for the underlying wire, in terms of its geometry (as opposed to orientation in relation to other shapes).

Constructor & Destructor Documentation

TopoDS_Wire()

TopoDS_Wire::TopoDS_Wire ( )

default

Undefined Wire.

---

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

• TopoDS_Wire.hxx