IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Types | Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
ipsdk::geom::PolygonWithHoles2d< T > Class Template Reference

Closed polygon potentially associated to interior polygonal holes. More...

#include <PolygonWithHoles2d.h>

Inheritance diagram for ipsdk::geom::PolygonWithHoles2d< T >:
ipsdk::geom::BaseTypedGeometryEntity2d< T > ipsdk::geom::BaseGeometryEntity2d ipsdk::geom::BaseGeometryEntity ipsdk::BaseObjectWithSkeleton ipsdk::BaseSerializationObject ipsdk::BaseDynamicObject

Public Types

typedef Polygon2d< T > PolygonType
 polygon type associated to object
 
typedef PolygonWithHoles2d< T > PolygonWithHolesType
 polygon with holes type associated to object
 
typedef boost::shared_ptr< PolygonWithHolesTypePolygonWithHolesPtr
 shared pointer to polygon with holes
 
typedef boost::shared_ptr< const PolygonWithHolesTypePolygonWithHolesConstPtr
 shared pointer to const polygon with holes
 
typedef boost::weak_ptr< const PolygonWithHolesTypePolygonWithHolesConstWeakPtr
 weak pointer to polygon with holes
 
typedef std::vector< PolygonWithHolesConstPtrPolygonConstColl
 collection of const polygons
 
typedef std::vector< PolygonWithHolesPtrPolygonColl
 collection of polygons
 
typedef PolygonColl::iterator HoleIterator
 iterator to collection of polygons
 
- Public Types inherited from ipsdk::geom::BaseTypedGeometryEntity2d< T >
typedef T DataType
 data type associated to coordinates
 

Public Member Functions

eCoordinateSystem2dType getCoordinateSystem2dType () const
 method allowing to retrieve coordinate system 2d type
 
eEntity2dType getEntity2dType () const
 method allowing to retrieve entity 2d type
 
const ePolygon2dTypegetPolygon2dType () const
 retrieve polygon 2d type
 
PolygonWithHolesConstPtr getParent () const
 retrieve parent polygon of instance More...
 
void setParent (const PolygonWithHolesConstPtr &pParent)
 set parent polygon of instance
 
ipUInt32 getNbTotPolygons () const
 
ipUInt32 getNbTotPoints () const
 
bool isEmpty () const
 method allowing to check whether polygon is empty
 
ipUInt32 getNbExteriorPoints () const
 retrieve number of exterior points
 
const PolygonTypegetExteriorPolygon () const
 get exterior polygon associated to object
 
PolygonTypegetExteriorPolygon ()
 access to exterior polygon associated to object
 
bool hasHoles () const
 method allowing to check whether polygon has holes
 
ipUInt32 getNbHoles () const
 method allowing to retrieve number of holes associated to polygon
 
const PolygonConstCollgetPolygonHoles () const
 get interior polygon holes
 
PolygonCollgetPolygonHoles ()
 access to interior polygon holes
 
void clearPolygonHoles ()
 clear of polygon holes collection
 
void clear ()
 clear all data associated to polygon with holes
 
Constructors and destructors
 PolygonWithHoles2d ()
 
 ~PolygonWithHoles2d ()
 
HoleIterator beginHole ()
 iterator used to parse polygon holes
 
HoleIterator endHole ()
 iterator used to parse polygon holes
 
- Public Member Functions inherited from ipsdk::geom::BaseTypedGeometryEntity2d< T >
 BaseTypedGeometryEntity2d ()
 
virtual ~BaseTypedGeometryEntity2d ()=0
 
- Public Member Functions inherited from ipsdk::geom::BaseGeometryEntity2d
eCoordinateDimension getCoordinateDimension () const
 method allowing to retrieve entity underlying coordinates dimension
 
 BaseGeometryEntity2d ()
 
virtual ~BaseGeometryEntity2d ()=0
 
- Public Member Functions inherited from ipsdk::geom::BaseGeometryEntity
 BaseGeometryEntity ()
 
virtual ~BaseGeometryEntity ()=0
 
- Public Member Functions inherited from ipsdk::BaseObjectWithSkeleton
const eSklSrzModegetSerializationMode () const
 retrieve serialization flag for object More...
 
void setSerializationMode (const eSklSrzMode &sklSrzMode) const
 set serialization flag for object
 
 BaseObjectWithSkeleton ()
 
 ~BaseObjectWithSkeleton ()
 
- Public Member Functions inherited from ipsdk::BaseSerializationObject
 BaseSerializationObject ()
 Default constructor.
 
virtual ~BaseSerializationObject ()=0
 destructor
 
- Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string & getClassName () const
 method allowing to retrieve object class name
 
virtual BaseDynamicObjectcreateNew () const =0
 method allowing to create new instance of current object type
 
virtual DynamicObjectPtr createShared () const =0
 method allowing to create new shared instance of current object type
 
virtual bool hasCopySupport () const =0
 check whether objet has copy support
 
virtual BaseDynamicObjectduplicate () const =0
 method allowing to duplicate current object More...
 
virtual DynamicObjectPtr duplicateShared () const =0
 method allowing shared duplication of current object More...
 
 BaseDynamicObject ()
 
virtual ~BaseDynamicObject ()=0
 

Static Public Attributes

static const eCoordinateSystem2dType::domain g_coordinateSystem2dType = eCoordinateSystem2dType::eCS2DT_Cartesian
 coordinate system associated to entity
 
static const eEntity2dType::domain g_entity2dType = eEntity2dType::eE2DT_PolygonWithHoles
 type associated to entity
 
- Static Public Attributes inherited from ipsdk::geom::BaseGeometryEntity2d
static const eCoordinateDimension::domain g_coordinateDimension = eCoordinateDimension::eCD_2d
 entity underlying coordinates dimension
 

Protected Attributes

PolygonWithHolesConstWeakPtr _pParent
 parent polygon associated to instance
 
PolygonType _exteriorPolygon
 exterior polygon
 
PolygonColl _polygonHoles
 collection of interior polygon holes
 
- Protected Attributes inherited from ipsdk::BaseObjectWithSkeleton
eSklSrzMode _sklSrzMode
 serialization flag for object More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32 getVersion ()
 method allowing to retrieve class version information for serialization
 
- Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string & getTypeName ()
 method allowing to retrieve name associated to class
 
- Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult write (BaseOArchive &ar) const
 method allowing to ensure serialization write part for object
 
virtual BoolResult read (BaseIArchive &ar)
 method allowing to ensure serialization read part for object
 
- Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void initCtorCopy (const BaseDynamicObject &object)
 
virtual void copy (const BaseDynamicObject &object)
 method allowing to copy data from another object
 

Detailed Description

template<typename T>
class ipsdk::geom::PolygonWithHoles2d< T >

Closed polygon potentially associated to interior polygonal holes.

Author
E. Noirfalise
Date
2015/04/29

Member Function Documentation

◆ getParent()

template<typename T >
PolygonWithHoles2d< T >::PolygonWithHolesConstPtr ipsdk::geom::PolygonWithHoles2d< T >::getParent ( ) const
inline

retrieve parent polygon of instance

Note
Parent polygon enclosed current polygon
Warning
may be null if not set

◆ getNbTotPolygons()

template<typename T>
ipUInt32 ipsdk::geom::PolygonWithHoles2d< T >::getNbTotPolygons ( ) const

retrieve total number of polygons including holes and internal polygons

◆ getNbTotPoints()

template<typename T>
ipUInt32 ipsdk::geom::PolygonWithHoles2d< T >::getNbTotPoints ( ) const

retrieve total number of polygon points (included holes points)


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