1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-07 18:30:55 +03:00
occt/src/BRepPrimAPI/BRepPrimAPI_MakeCylinder.cdl
abv d5f74e42d6 0024624: Lost word in license statement in source files
License statement text corrected; compiler warnings caused by Bison 2.41 disabled for MSVC; a few other compiler warnings on 54-bit Windows eliminated by appropriate type cast
Wrong license statements corrected in several files.
Copyright and license statements added in XSD and GLSL files.
Copyright year updated in some files.
Obsolete documentation files removed from DrawResources.
2014-02-20 16:15:17 +04:00

106 lines
3.8 KiB
Plaintext

-- Created on: 1993-07-21
-- Created by: Remi LEQUETTE
-- 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.
class MakeCylinder from BRepPrimAPI inherits MakeOneAxis from BRepPrimAPI
---Purpose: Describes functions to build cylinders or portions of cylinders.
-- A MakeCylinder object provides a framework for:
-- - defining the construction of a cylinder,
-- - implementing the construction algorithm, and
-- - consulting the result.
uses
Ax2 from gp,
Cylinder from BRepPrim,
OneAxis from BRepPrim
raises
DomainError from Standard
is
Create(R, H : Real)
returns MakeCylinder from BRepPrimAPI
---Purpose: Make a cylinder of radius R and length H.
---Level: Public
raises
DomainError from Standard; -- if R or H <= Precision::Confusion()
Create(R, H, Angle : Real)
returns MakeCylinder from BRepPrimAPI
---Purpose: Make a cylinder of radius R and length H with
-- angle H.
---Level: Public
raises
DomainError from Standard; -- if R or H <= Precision::Confusion()
Create(Axes : Ax2 from gp; R, H : Real)
returns MakeCylinder from BRepPrimAPI
---Purpose: Make a cylinder of radius R and length H.
---Level: Public
raises
DomainError from Standard; -- if R or H <= Precision::Confusion()
Create(Axes : Ax2 from gp; R, H, Angle : Real)
returns MakeCylinder from BRepPrimAPI
---Purpose: Make a cylinder of radius R and length H with
-- angle H.
---Level: Public
raises
DomainError from Standard; -- if R or H <= Precision::Confusion()
---Purpose: Constructs
-- - a cylinder of radius R and height H, or
-- - a portion of cylinder of radius R and height H, and of
-- the angle Angle defining the missing portion of the cylinder.
-- The cylinder is constructed about the "Z Axis" of either:
-- - the global coordinate system, or
-- - the local coordinate system Axes.
-- It is limited in this coordinate system as follows:
-- - in the v parametric direction (the Z axis), by the two
-- parameter values 0 and H,
-- - and in the u parametric direction (the rotation angle
-- around the Z Axis), in the case of a portion of a
-- cylinder, by the two parameter values 0 and Angle.
-- Angle is given in radians.
-- The resulting shape is composed of:
-- - a lateral cylindrical face,
-- - two planar faces in the planes z = 0 and z = H
-- (in the case of a complete cylinder, these faces are circles), and
-- - in case of a portion of a cylinder, two additional
-- planar faces to close the shape.(two rectangles in the
-- planes u = 0 and u = Angle).
-- Exceptions Standard_DomainError if:
-- - R is less than or equal to Precision::Confusion(), or
-- - H is less than or equal to Precision::Confusion().
OneAxis(me : in out) returns Address;
---Purpose: Returns the algorithm.
---Level: Advanced
Cylinder(me : in out) returns Cylinder from BRepPrim
---Purpose: Returns the algorithm.
--
---C++: return &
---Level: Public
is static;
fields
myCylinder : Cylinder from BRepPrim;
end MakeCylinder;