TopAbs Class Reference

This package gives resources for Topology oriented applications such as: Topological Data Structure, Topological Algorithms. More...

#include <TopAbs.hxx>

Static Public Member Functions
static TopAbs_Orientation	Compose (const TopAbs_Orientation Or1, const TopAbs_Orientation Or2) noexcept
	Compose the Orientation <Or1> and <Or2>. This composition is not symmetric (if you switch <Or1> and <Or2> the result is different). It assumes that <Or1> is the Orientation of a Shape S1 containing a Shape S2 of Orientation Or2. The result is the cumulated orientation of S2 in S1. The composition law is:
static TopAbs_Orientation	Reverse (const TopAbs_Orientation Or) noexcept
	Exchanges the interior/exterior status of the two sides. This is what happens when the sense of direction is reversed. The following rules apply:
static TopAbs_Orientation	Complement (const TopAbs_Orientation Or) noexcept
	Reverses the interior/exterior status of each side of the object. So, to take the complement of an object means to reverse the interior/exterior status of its boundary, i.e. inside becomes outside. The method returns the complementary orientation, following the rules in the table below: FORWARD REVERSED REVERSED FORWARD INTERNAL EXTERNAL EXTERNAL INTERNAL.
static Standard_OStream &	Print (const TopAbs_ShapeEnum theShapeType, Standard_OStream &theStream)
	Prints the name of Shape type as a String on the Stream.
static Standard_OStream &	Print (const TopAbs_Orientation theOrientation, Standard_OStream &theStream)
	Prints the name of the Orientation as a String on the Stream.
static Standard_OStream &	Print (const TopAbs_State St, Standard_OStream &S)
	Prints the name of the State <St> as a String on the Stream and returns .
static const char *	ShapeTypeToString (TopAbs_ShapeEnum theType)
	Returns the string name for a given shape type.
static TopAbs_ShapeEnum	ShapeTypeFromString (const char *theTypeString)
	Returns the shape type from the given string identifier (using case-insensitive comparison).
static bool	ShapeTypeFromString (const char *theTypeString, TopAbs_ShapeEnum &theType)
	Determines the shape type from the given string identifier (using case-insensitive comparison).
static const char *	ShapeOrientationToString (TopAbs_Orientation theOrientation)
	Returns the string name for a given shape orientation.
static TopAbs_Orientation	ShapeOrientationFromString (const char *const theOrientationString)
	Returns the shape orientation from the given string identifier (using case-insensitive comparison).
static bool	ShapeOrientationFromString (const char *const theOrientationString, TopAbs_Orientation &theOrientation)
	Determines the shape orientation from the given string identifier (using case-insensitive comparison).

Detailed Description

This package gives resources for Topology oriented applications such as: Topological Data Structure, Topological Algorithms.

It contains the:

• ShapeEnum enumeration to describe the different topological shapes.
• Orientation enumeration to describe the orientation of a topological shape.
• State enumeration to describes the position of a point relative to a Shape.
• Methods to manage the enumerations.

Member Function Documentation

Complement()

TopAbs_Orientation TopAbs::Complement ( const TopAbs_Orientation Or )

inlinestaticnoexcept

Reverses the interior/exterior status of each side of the object. So, to take the complement of an object means to reverse the interior/exterior status of its boundary, i.e. inside becomes outside. The method returns the complementary orientation, following the rules in the table below: FORWARD REVERSED REVERSED FORWARD INTERNAL EXTERNAL EXTERNAL INTERNAL.

Complement complements the material side. Inside becomes outside.

Compose()

TopAbs_Orientation TopAbs::Compose ( const TopAbs_Orientation Or1, const TopAbs_Orientation Or2 )

inlinestaticnoexcept

Compose the Orientation <Or1> and <Or2>. This composition is not symmetric (if you switch <Or1> and <Or2> the result is different). It assumes that <Or1> is the Orientation of a Shape S1 containing a Shape S2 of Orientation Or2. The result is the cumulated orientation of S2 in S1. The composition law is:

\ Or2 FORWARD REVERSED INTERNAL EXTERNAL Or1 ----------------------------------— FORWARD | FORWARD REVERSED INTERNAL EXTERNAL | REVERSED | REVERSED FORWARD INTERNAL EXTERNAL | INTERNAL | INTERNAL INTERNAL INTERNAL INTERNAL | EXTERNAL | EXTERNAL EXTERNAL EXTERNAL EXTERNAL Note: The top corner in the table is the most important for the purposes of Open CASCADE topology and shape sharing.

Print() [1/3]

Standard_OStream & TopAbs::Print ( const TopAbs_Orientation theOrientation, Standard_OStream & theStream )

inlinestatic

Prints the name of the Orientation as a String on the Stream.

Print() [2/3]

Standard_OStream & TopAbs::Print ( const TopAbs_ShapeEnum theShapeType, Standard_OStream & theStream )

inlinestatic

Prints the name of Shape type as a String on the Stream.

Print() [3/3]

Standard_OStream & TopAbs::Print ( const TopAbs_State St, Standard_OStream & S )

static

Prints the name of the State <St> as a String on the Stream and returns .

Reverse()

TopAbs_Orientation TopAbs::Reverse ( const TopAbs_Orientation Or )

inlinestaticnoexcept

Exchanges the interior/exterior status of the two sides. This is what happens when the sense of direction is reversed. The following rules apply:

FORWARD REVERSED REVERSED FORWARD INTERNAL INTERNAL EXTERNAL EXTERNAL

Reverse exchange the material sides.

ShapeOrientationFromString() [1/2]

TopAbs_Orientation TopAbs::ShapeOrientationFromString ( const char *const theOrientationString )

inlinestatic

Returns the shape orientation from the given string identifier (using case-insensitive comparison).

Parameters

theOrientationString

string identifier

Returns

shape orientation or TopAbs_FORWARD if string identifier is invalid

ShapeOrientationFromString() [2/2]

bool TopAbs::ShapeOrientationFromString ( const char *const theOrientationString, TopAbs_Orientation & theOrientation )

static

Determines the shape orientation from the given string identifier (using case-insensitive comparison).

Parameters

theOrientationString	string identifier
theOrientation	detected shape orientation

Returns

TRUE if string identifier is known

ShapeOrientationToString()

const char * TopAbs::ShapeOrientationToString ( TopAbs_Orientation theOrientation )

static

Returns the string name for a given shape orientation.

Parameters

theOrientation

shape orientation

Returns

string identifier from the list FORWARD, REVERSED, INTERNAL, EXTERNAL

ShapeTypeFromString() [1/2]

TopAbs_ShapeEnum TopAbs::ShapeTypeFromString ( const char * theTypeString )

inlinestatic

Returns the shape type from the given string identifier (using case-insensitive comparison).

Parameters

theTypeString

string identifier

Returns

shape type or TopAbs_SHAPE if string identifier is invalid

ShapeTypeFromString() [2/2]

bool TopAbs::ShapeTypeFromString ( const char * theTypeString, TopAbs_ShapeEnum & theType )

static

Determines the shape type from the given string identifier (using case-insensitive comparison).

Parameters

theTypeString	string identifier
theType	detected shape type

Returns

TRUE if string identifier is known

ShapeTypeToString()

const char * TopAbs::ShapeTypeToString ( TopAbs_ShapeEnum theType )

static

Returns the string name for a given shape type.

Parameters

theType

shape type

Returns

string identifier from the list COMPOUND, COMPSOLID, SOLID, SHELL, FACE, WIRE, EDGE, VERTEX, SHAPE

---

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

• TopAbs.hxx