1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-16 10:08:36 +03:00
occt/src/IGESDraw/IGESDraw_CircArraySubfigure.hxx
abv 42cf5bc1ca 0024002: Overall code and build procedure refactoring -- automatic
Automatic upgrade of OCCT code by command "occt_upgrade . -nocdl":
- WOK-generated header files from inc and sources from drv are moved to src
- CDL files removed
- All packages are converted to nocdlpack
2015-07-12 07:42:38 +03:00

138 lines
4.5 KiB
C++

// Created on: 1993-01-11
// Created by: CKY / Contract Toubro-Larsen ( Niraj RANGWALA )
// Copyright (c) 1993-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.
#ifndef _IGESDraw_CircArraySubfigure_HeaderFile
#define _IGESDraw_CircArraySubfigure_HeaderFile
#include <Standard.hxx>
#include <Standard_Type.hxx>
#include <Standard_Integer.hxx>
#include <gp_XYZ.hxx>
#include <Standard_Real.hxx>
#include <TColStd_HArray1OfInteger.hxx>
#include <IGESData_IGESEntity.hxx>
#include <Standard_Boolean.hxx>
class IGESData_IGESEntity;
class Standard_OutOfRange;
class gp_XYZ;
class gp_Pnt;
class IGESDraw_CircArraySubfigure;
DEFINE_STANDARD_HANDLE(IGESDraw_CircArraySubfigure, IGESData_IGESEntity)
//! Defines IGES Circular Array Subfigure Instance Entity,
//! Type <414> Form Number <0> in package IGESDraw
//!
//! Used to produce copies of object called the base entity,
//! arranging them around the edge of an imaginary circle
//! whose center and radius are specified
class IGESDraw_CircArraySubfigure : public IGESData_IGESEntity
{
public:
Standard_EXPORT IGESDraw_CircArraySubfigure();
//! This method is used to set the fields of the class
//! CircArraySubfigure
//! - aBase : Base entity
//! - aNumLocs : Total number of possible instance locations
//! - aCenter : Coordinates of Center of imaginary circle
//! - aRadius : Radius of imaginary circle
//! - aStAngle : Start angle in radians
//! - aDelAngle : Delta angle in radians
//! - aFlag : DO-DON'T flag to control which portion to
//! display
//! - allNumPos : All position to be or not to be processed
Standard_EXPORT void Init (const Handle(IGESData_IGESEntity)& aBase, const Standard_Integer aNumLocs, const gp_XYZ& aCenter, const Standard_Real aRadius, const Standard_Real aStAngle, const Standard_Real aDelAngle, const Standard_Integer aFlag, const Handle(TColStd_HArray1OfInteger)& allNumPos);
//! returns the base entity, copies of which are produced
Standard_EXPORT Handle(IGESData_IGESEntity) BaseEntity() const;
//! returns total number of possible instance locations
Standard_EXPORT Standard_Integer NbLocations() const;
//! returns the center of the imaginary circle
Standard_EXPORT gp_Pnt CenterPoint() const;
//! returns the Transformed center of the imaginary circle
Standard_EXPORT gp_Pnt TransformedCenterPoint() const;
//! returns the radius of the imaginary circle
Standard_EXPORT Standard_Real CircleRadius() const;
//! returns the start angle in radians
Standard_EXPORT Standard_Real StartAngle() const;
//! returns the delta angle in radians
Standard_EXPORT Standard_Real DeltaAngle() const;
//! returns 0 if all elements to be displayed
Standard_EXPORT Standard_Integer ListCount() const;
//! returns True if (ListCount = 0) all elements are to be displayed
Standard_EXPORT Standard_Boolean DisplayFlag() const;
//! returns 0 if half or fewer of the elements of the array are defined
//! 1 if half or more of the elements are defined
Standard_EXPORT Standard_Boolean DoDontFlag() const;
//! returns whether Index is to be processed (DO)
//! or not to be processed(DON'T)
//! if (ListCount = 0) return theDoDontFlag
//! raises exception if Index <= 0 or Index > ListCount().
Standard_EXPORT Standard_Boolean PositionNum (const Standard_Integer Index) const;
//! returns the Index'th value position
//! raises exception if Index <= 0 or Index > ListCount().
Standard_EXPORT Standard_Integer ListPosition (const Standard_Integer Index) const;
DEFINE_STANDARD_RTTI(IGESDraw_CircArraySubfigure,IGESData_IGESEntity)
protected:
private:
Handle(IGESData_IGESEntity) theBaseEntity;
Standard_Integer theNbLocations;
gp_XYZ theCenter;
Standard_Real theRadius;
Standard_Real theStartAngle;
Standard_Real theDeltaAngle;
Standard_Integer theDoDontFlag;
Handle(TColStd_HArray1OfInteger) thePositions;
};
#endif // _IGESDraw_CircArraySubfigure_HeaderFile