Close

Relief for ODA Team in Ukraine

Learn more
ODA Kernel SDK
API Reference > OdGe Classes > OdGeTorus Class
OdGeTorus Class
Syntax
C++
class OdGeTorus : public OdGeSurface;

This class represents toroidal segments.

The torus is surface generated by revolving a circular arc about an axis of symmetry, where the plane of the circular arc contains the axis of symmetry 

The torus is located in space by its center, which is a point on the axis of symmetry. 

The center of the circular arc is at a distance of majorRadius from the center of the torus. The radius of the circular arc is the minorRadius. 

Parameter U parameterizes the circular tube, which for a closed circle defaults to the range [-OdaPI, OdaPI). Applying the right hand rule along the (axisOfSymmetry X refAxis) defines the increasing direction for U. 

Parameter V is the longitude (about the axis of symmetry), which for a closed torus defaults to the range [-OdaPI, OdaPI). Zero corresponds to the refAxis (which is a vector orthogonal to the axis of symmetry). Applying the right hand rule along the symmetric axis defines the increasing direction for V. However, if isReverseV() is true, the increasing direction for V is defined by the left hand rule. 

The torus is periodic in U, V with a period of Oda2PI. [umin, umax] x [vmin, vmax] defines a four sided toroidal patch bounded by four circular arcs. Following constraints apply to the definition of a toroidal patch. 

  • umin < umax and |umin - umax| <= Oda2PI.
  • vmin < vmax and |vmin - vmax| <= Oda2PI
 

Corresponding C++ library: TD_Ge 

 

Working with Toruses 

OdGeTorusOdGeTorusOdGeTorus

File: GeTorus.h 

Module: API Reference 

Show:
No members matching the current filter
OdGeTorus()
This is the overview for the OdGeTorus constructor overload.
~OdGeEntity3d
Destructor for the OdGeEntity3d class. (Inherited from OdGeEntity3d)
Show:
No members matching the current filter
GE_OPERATORS_OVERRIDE_3D
(Inherited from OdGeSurface)
GE_OPERATORS_OVERRIDE_3D
axisOfSymmetry
Returns the axis of symmetry (rotation) of this torus.
center
Returns the center of this torus.
closestPointTo(const OdGePoint3d &, OdGePoint2d *, const OdGeUvBox*, const OdGeTol &)
This is the overview for the closestPointTo method overload.
copy
Returns a copy of this entity. (Inherited from OdGeEntity3d)
distanceTo
Returns the distance to the point on this curve closest to the specified point.
(Inherited from OdGeSurface)
evalPoint(const OdGePoint2d&)
This is the overview for the evalPoint method overload.
getAnglesInU
Retrieves the start and end angles about the axis of symmetry.
getAnglesInV
Retrieves the start and end angles about the tube.
getClosestPointTo
Returns the point on this surface closest to the specified point.
(Inherited from OdGeSurface)
getEnvelope(OdGeInterval&, OdGeInterval&)
This is the overview for the getEnvelope method overload.
getGeomExtents
Returns bounding box of the whole surface or a part of it. The box is axis-aligned in the specified local coordinate system. It is guaranteed to enclose the surface, but not guaranteed to be tight/minimal.
(Inherited from OdGeSurface)
getPoles
Finds all poles of surface. Surface envelope not considered. In case of NurbSurface extreme points of envelope are checked. Input arrays may be not empty. In this case new poles will be written to the ends of the arrays.
(Inherited from OdGeSurface)
intersectWith
Checks if the torus intersects with the specified line entity, and returns the number of intersections and the points of intersection.
isApple
Checks if (0 < majorRadius < |minorRadius| - OdGeContext::gTol.equalVector()), creating a solid with dimples at the axis of symmetry.
isClosedInU
Returns true if and only if this surface is closed in the U direction.
(Inherited from OdGeSurface)
isClosedInV
Returns true if and only if this surface is closed in the V direction.
(Inherited from OdGeSurface)
isDegenerate
Checks if torus is not Doughnut.
isDoughnut
Checks if (majorRadius >= |minorRadius| - OdGeContext::gTol.equalVector()), creating a solid with a hole in the middle.
isEqualTo
Checks whether the specified entity is equal to this one.
(Inherited from OdGeEntity3d)
isHollow
Checks if the minor radius of the torus is less than zero.
isKindOf
Returns true if and only if this entity is of type (or is derived from) entType.
(Inherited from OdGeEntity3d)
isLeftHanded
Checks orientation of the surface.
(Inherited from OdGeSurface)
isLemon
Checks if (majorRadius <= 0), producing a solid with points along the axis of symmetry.
isNormalReversed
Checks normal direction. (Inherited from OdGeSurface)
isOn
Returns true if and only if the specified point is on this entity, as determined by the tolerance.
(Inherited from OdGeEntity3d)
isOn
Determines if the passed point is on this surface and retrieves a 2D point that represents parametric values for the passed 3D point if it is on this surface.
(Inherited from OdGeSurface)
isOuterNormal
Checks if the normal to this surface is pointing outward.
isReverseV
Checks whether V parameter increases in clockwise direction around axisOfSymmetry.
isVortex
Checks if (|majorRadius - |minorRadius|| < OdGeContext::gTol.equalVector()), producing a doughnut. with a zero-radius hole.
majorRadius
Returns the major radius of this torus.
makeIsoparamCurve(bool, double)
This is the overview for the makeIsoparamCurve method overload.
minorRadius
Returns the minor radius of this torus.
mirror
Mirrors this entity about the specified plane, and returns a reference to this entity.
(Inherited from OdGeEntity3d)
paramOf(const OdGePoint3d&, const OdGeTol&)
This is the overview for the paramOf method overload.
project
Projects a point onto this surface.
(Inherited from OdGeSurface)
refAxis
Returns the reference axis of this torus.
reverseNormal
Reverses the normal of this surface. (Inherited from OdGeSurface)
rotateBy
Rotates this entity by the specified angle about the axis defined by the point and the vector, and returns a reference to this entity.
(Inherited from OdGeEntity3d)
scaleBy
Scales this entity by the scale factor about the basepoint, and returns a reference to this entity.
(Inherited from OdGeEntity3d)
set(double, double, const OdGePoint3d&, const OdGeVector3d&)
This is the overview for the set method overload.
setAnglesInU
Sets the start and end angles about about the axis of symmetry.
setAnglesInV
Sets the start and end angles about about the tube.
setEnvelope
Set the rectangle in parameter space that defines the parameter domain of this surface. (Inherited from OdGeSurface)
setMajorRadius
Sets the major radius of this torus.
setMinorRadius
Sets the minor radius of this torus.
setReverseV
Specifies whether the V parameter should be measured clockwise around axisOfSymmetry, rather than counterclockwise.
transformBy
Applies the 3D transformation matrix to this entity, and returns a reference to this entity.
(Inherited from OdGeEntity3d)
translateBy
Applies the 3D translation vector to this entity, and returns a reference to this entity.
(Inherited from OdGeEntity3d)
type
Returns the entity type. (Inherited from OdGeEntity3d)
Show:
No members matching the current filter
!=
Comparison operator for the OdGeEntity3d object.
(Inherited from OdGeEntity3d)
=
Assignment operator for the OdGeEntity3d object.
(Inherited from OdGeEntity3d)
=
Assignment operator for the OdGeSurface class.
(Inherited from OdGeSurface)
=
Assignment operator for the OdGeTorus object.
==
Comparison operator for the OdGeEntity3d object.
(Inherited from OdGeEntity3d)
Send feedback about this topic
Copyright © 2002-2022. Open Design Alliance All rights reserved.