GeTorus.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef OD_GETORUS_H
#define OD_GETORUS_H 
 
#include "OdPlatform.h"
#include "Ge/GeSurface.h"
#include "Ge/GeCircArc3d.h"
 
#include "TD_PackPush.h"

class GE_TOOLKIT_EXPORT OdGeTorus : public OdGeSurface
{
public:
  GE_OPERATORS_OVERRIDE_3D(OdGeTorus);

  OdGeTorus();
  
  OdGeTorus(
    double majorRadius, 
    double minorRadius,
    const OdGePoint3d& center, 
    const OdGeVector3d& axisOfSymmetry);
  
  OdGeTorus(
    double majorRadius, 
    double minorRadius,
    const OdGePoint3d& center, 
    const OdGeVector3d& axisOfSymmetry,
    const OdGeVector3d& refAxis,
    double startAngleU, 
    double endAngleU,
    double startAngleV, 
    double endAngleV);
  
  OdGeTorus(
    const OdGeTorus& source);
 
  // Geometric properties.
  //

   double majorRadius() const;

   double minorRadius() const;

   void getAnglesInU(
    double& startAngleU, 
    double& endAngleU) const;

   void getAnglesInV(
    double& startAngleV, 
    double& endAngleV) const;

   OdGePoint3d center() const;

   OdGeVector3d axisOfSymmetry() const;

   OdGeVector3d refAxis() const;

   bool isOuterNormal() const;

   OdGeTorus& setMajorRadius(
    double radius);

   OdGeTorus& setMinorRadius(
    double radius);

   OdGeTorus& setAnglesInU(
    double startAngleU, 
    double endAngleU);

   OdGeTorus& setAnglesInV(
    double startAngleV, 
    double endAngleV);

   OdGeTorus& set(
    double majorRadius, 
    double minorRadius,
    const OdGePoint3d& center,
    const OdGeVector3d& axisOfSymmetry);

   OdGeTorus& set(
    double majorRadius, 
    double minorRadius,
    const OdGePoint3d&  center,
    const OdGeVector3d& axisOfSymmetry,
    const OdGeVector3d& refAxis,
    double startAngleU, 
    double endAngleU,
    double startAngleV, 
    double endAngleV);

  OdGeTorus& operator =(
    const OdGeTorus& torus);

   bool intersectWith(
    const OdGeLinearEnt3d& linEnt, 
    int& numInt,
    OdGePoint3d& p1, 
    OdGePoint3d& p2,
    OdGePoint3d& p3, 
    OdGePoint3d& p4,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  // Shape Classification Functions

   bool isLemon() const;

   bool isApple() const;

   bool isVortex() const;

   bool isDoughnut() const;

   bool isDegenerate() const;

   bool isHollow() const;

   bool isReverseV() const;

   void setReverseV(
     bool isReverseV);

 
};
 
#include "TD_PackPop.h"
 
#endif // OD_GETORUS_H