Close

Relief for ODA Team in Ukraine

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

This class represents right circular cylinders.

A right circular cylinder is defined by its 

  • radius
  • axis of symmetry
  • origin (a point on the axis)
  • U parameter scale.
 

It is generated by revolving a line parallel to the axis of symmetry, at a the radius distance. 

The height interval of this cylinder is specified relative to its origin. Height is increasing in the direction of the symmetric axis. Height interval can be unbounded. 

The cylinder is parameterized as follows: 

Parameter V is the angle of revolution measured from the refAxis (an axis perpendicular to the axis of symmetry). For a closed cylinder, it defaults to [-OdaPI, OdaPI). The right hand rule applied along the direction of the axis of symmetry defines the positive direction of V. The surface is periodic in V with a period of Oda2PI. 

Parameter U varies along the generating line. U is dimensionless, measured in U parameter scale (which equals to the radius by default). U increases in the direction of the axis of symmetry. However, if U parameter scale is negative, U decreases in the direction of the axis of symmetry. U = 0 corresponds to the base of this cylinder. 

[umin, umax] x [vmin, vmax] defines a four sided cylindrical patch bounded by two straight lines (at vmin and vmax), and two circular arcs (at umin and umax). The following constraints apply to the definition of a cylindrical patch: 

  • umin < umax
  • |vmax - vmin| <= Oda2PI.
  • radius > 0.0
 

Corresponding C++ library: TD_Ge 

 

OdGeCylinderOdGeCylinderOdGeCylinder

File: GeCylinder.h 

Module: API Reference 

Show:
No members matching the current filter
OdGeCylinder()
This is the overview for the OdGeCylinder constructor overload.
~OdGeEntity3d
Destructor for the OdGeEntity3d class. (Inherited from OdGeEntity3d)
Show:
No members matching the current filter
GE_OPERATORS_OVERRIDE_3D
GE_OPERATORS_OVERRIDE_3D
(Inherited from OdGeSurface)
axisOfSymmetry
Returns the axis of symmetry of this cylinder.
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.
getAngles
Retrieves the starting and ending angles of this cylinder.
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)
getHeight
Retrieves the interval of the axis of symmetry.
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)
getUParamScale
Retrieves U parameter scale.
heightAt
Returns the height of this cylinder corresponding to the specified position on the U-axis.
intersectWith
Checks if this cylinder intersects with a line entity, and retrieves the number of intersections and the points of intersection.
isClosed
Checks if the base of this cylinder is a full circle within the specified tolerance.
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)
isEqualTo
Checks whether the specified entity is equal to this one.
(Inherited from OdGeEntity3d)
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)
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.
makeIsoparamCurve(bool, double)
This is the overview for the makeIsoparamCurve method overload.
mirror
Mirrors this entity about the specified plane, and returns a reference to this entity.
(Inherited from OdGeEntity3d)
origin
Returns the origin of this cylinder.
paramOf(const OdGePoint3d&, const OdGeTol&)
This is the overview for the paramOf method overload.
project
Projects a point onto this surface.
(Inherited from OdGeSurface)
radius
Returns the radius of this cylinder.
refAxis
Returns the reference axis of this cylinder.
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, const OdGePoint3d&, const OdGeVector3d&)
This is the overview for the set method overload.
setAngles
Sets the starting and ending angles of this cylinder.
setEnvelope
Set the rectangle in parameter space that defines the parameter domain of this surface. (Inherited from OdGeSurface)
setHeight
Sets the height interval of this cylinder.
setIsOuterNormal
Sets if the cylinder normal is pointing outward.
setRadius
Sets the radius of this cylinder.
setUParamScale
Sets U parameter scale according to the parameter.
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 OdGeCylinder object.
=
Assignment operator for the OdGeEntity3d object.
(Inherited from OdGeEntity3d)
=
Assignment operator for the OdGeSurface class.
(Inherited from OdGeSurface)
==
Comparison operator for the OdGeEntity3d object.
(Inherited from OdGeEntity3d)
Send feedback about this topic
Copyright © 2002-2022. Open Design Alliance All rights reserved.