CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
OdGeBoundBlock2d Class Reference

#include <GeBoundBlock2d.h>

Inheritance diagram for OdGeBoundBlock2d:
OdGeEntity2d

Public Member Functions

 OdGeBoundBlock2d ()
 
 OdGeBoundBlock2d (const OdGePoint2d &point1, const OdGePoint2d &point2)
 
 OdGeBoundBlock2d (const OdGePoint2d &base, const OdGeVector2d &dir1, const OdGeVector2d &dir2)
 
 OdGeBoundBlock2d (const OdGeBoundBlock2d &source)
 
void getMinMaxPoints (OdGePoint2d &p1, OdGePoint2d &p2) const
 
void get (OdGePoint2d &base, OdGeVector2d &side1, OdGeVector2d &side2) const
 
OdGeBoundBlock2dset (const OdGePoint2d &p1, const OdGePoint2d &p2)
 
OdGeBoundBlock2dset (const OdGePoint2d &base, const OdGeVector2d &side1, const OdGeVector2d &side2)
 
OdGeBoundBlock2dextend (const OdGePoint2d &point)
 
OdGeBoundBlock2dswell (double distance)
 
bool contains (const OdGePoint2d &point, const OdGeTol &tol=OdGeContext::gTol) const
 
bool isDisjoint (const OdGeBoundBlock2d &block, const OdGeTol &tol=OdGeContext::gTol) const
 
OdGeBoundBlock2doperator= (const OdGeBoundBlock2d &block)
 
bool isBox () const
 
OdGeBoundBlock2dsetToBox (bool toBox)
 
- Public Member Functions inherited from OdGeEntity2d
 ODRX_HEAP_OPERATORS ()
 
 ~OdGeEntity2d ()
 
bool isKindOf (OdGe::EntityId entType) const
 
OdGe::EntityId type () const
 
OdGeEntity2dcopy () const
 
OdGeEntity2doperator= (const OdGeEntity2d &entity)
 
bool operator== (const OdGeEntity2d &entity) const
 
bool operator!= (const OdGeEntity2d &entity) const
 
bool isEqualTo (const OdGeEntity2d &other, const OdGeTol &tol=OdGeContext::gTol) const
 
OdGeEntity2dtransformBy (const OdGeMatrix2d &xfm)
 
OdGeEntity2dtranslateBy (const OdGeVector2d &translateVec)
 
OdGeEntity2drotateBy (double angle, const OdGePoint2d &basePoint=OdGePoint2d::kOrigin)
 
OdGeEntity2dmirror (const OdGeLine2d &line)
 
OdGeEntity2dscaleBy (double scaleFactor, const OdGePoint2d &basePoint=OdGePoint2d::kOrigin)
 
bool isOn (const OdGePoint2d &point, const OdGeTol &tol=OdGeContext::gTol) const
 

Additional Inherited Members

- Protected Member Functions inherited from OdGeEntity2d
 OdGeEntity2d ()
 
 OdGeEntity2d (const OdGeEntity2d &)
 
void connectTo (OdGeEntity2dImpl *)
 

Detailed Description

This class implements a 2D bounding area.

Corresponding C++ library: TD_Ge

<group OdGe_Classes>

See also
<link ge_OdGeBoundBlock3D, Working with Bounding Blocks>

Definition at line 42 of file GeBoundBlock2d.h.

Constructor & Destructor Documentation

◆ OdGeBoundBlock2d() [1/4]

OdGeBoundBlock2d::OdGeBoundBlock2d ( )

The default constructor for the OdGeBoundBlock2d class. Constructs a parallelogram reduced to the coordinate origin.

◆ OdGeBoundBlock2d() [2/4]

OdGeBoundBlock2d::OdGeBoundBlock2d ( const OdGePoint2d point1,
const OdGePoint2d point2 
)

Constructor for the OdGeBoundBlock2d class.

Parameters
point1[in] First point of a coordinate-aligned box.
point2[in] Second point of a coordinate-aligned box.
Remarks
The constructor constructs a box bounded by first and second input points.

◆ OdGeBoundBlock2d() [3/4]

OdGeBoundBlock2d::OdGeBoundBlock2d ( const OdGePoint2d base,
const OdGeVector2d dir1,
const OdGeVector2d dir2 
)

Constructor for the OdGeBoundBlock2d class.

Parameters
base[in] Base of a parallelogram bounding block.
dir1[in] First side of a parallelogram bounding block.
dir2[in] Second side of a parallelogram bounding block.
Remarks
The constructor constructs a parallelogram with given point and two sides.

◆ OdGeBoundBlock2d() [4/4]

OdGeBoundBlock2d::OdGeBoundBlock2d ( const OdGeBoundBlock2d source)

Copy constructor for the OdGeBoundBlock2d class.

Parameters
source[in] Object to be copied.
Remarks
Copies the input OdGeBoundBlock2d object.

Member Function Documentation

◆ contains()

bool OdGeBoundBlock2d::contains ( const OdGePoint2d point,
const OdGeTol tol = OdGeContext::gTol 
) const

Checks whether the point is contained in the bounding block.

Parameters
point[in] Any 2D point.
tol[in] Geometric tolerance.
Returns
true if the point is contained in the bounding block.

◆ extend()

OdGeBoundBlock2d & OdGeBoundBlock2d::extend ( const OdGePoint2d point)

Extends the bounding block to contain the specified point.

Parameters
point[in] Any 2D point.

◆ get()

void OdGeBoundBlock2d::get ( OdGePoint2d base,
OdGeVector2d side1,
OdGeVector2d side2 
) const

Returns base and sides of bounding block.

Parameters
base[out] Receives the base of bounding block.
side1[out] Receives the first side of bounding block.
side2[out] Receives the second side of bounding block.

◆ getMinMaxPoints()

void OdGeBoundBlock2d::getMinMaxPoints ( OdGePoint2d p1,
OdGePoint2d p2 
) const

Returns the extents of the bounding block.

Parameters
p1[out] Receives the first corner of the extents.
p2[out] Receives the second corner of the extents.

◆ isBox()

bool OdGeBoundBlock2d::isBox ( ) const

Returns true if and only if this bounding block is a coordinate-aligned box.

◆ isDisjoint()

bool OdGeBoundBlock2d::isDisjoint ( const OdGeBoundBlock2d block,
const OdGeTol tol = OdGeContext::gTol 
) const

Checks whether the specified bounding block does not intersect this bounding block.

Parameters
block[in] Any 2D bounding block.
tol[in] Geometric tolerance.
Returns
true if the specified bounding block does not intersect this bounding block.

◆ operator=()

OdGeBoundBlock2d & OdGeBoundBlock2d::operator= ( const OdGeBoundBlock2d block)

The assignment operator for the OdGeBoundBlock2d class.

Parameters
block[in] Input OdGeBoundBlock2d object.
Remarks
Makes this block identical to the input block.

◆ set() [1/2]

OdGeBoundBlock2d & OdGeBoundBlock2d::set ( const OdGePoint2d base,
const OdGeVector2d side1,
const OdGeVector2d side2 
)

Sets the bounding block to a parallelogram bounding block.

Parameters
base[in] Base of parallelogram bounding block.
side1[in] First side of parallelogram bounding block.
side2[in] Second side of parallelogram bounding block.

◆ set() [2/2]

OdGeBoundBlock2d & OdGeBoundBlock2d::set ( const OdGePoint2d p1,
const OdGePoint2d p2 
)

Sets the bounding block to a coordinate-aligned box.

Parameters
p1[in] First point of a coordinate-aligned box.
p2[in] Second point of a coordinate-aligned box.

◆ setToBox()

OdGeBoundBlock2d & OdGeBoundBlock2d::setToBox ( bool  toBox)

Sets this bounding block to a coordinate-aligned box, or a parallelogram bounding block. Returns a reference to this bounding block.

Parameters
toBox[in] If true, sets this bounding block to a coordinate-aligned box; otherwise, sets it to a parallelogram bounding block.

◆ swell()

OdGeBoundBlock2d & OdGeBoundBlock2d::swell ( double  distance)

Moves the walls of the bounding block the specified distance.

Parameters
distance[in] Distance.

The documentation for this class was generated from the following file: