Shape 2d associated to one or more closed polygon 2d. More...

#include <Shape2d.h>

Inheritance diagram for ipsdk::geom::Shape2d:

Public Types
typedef Shape2dPolygonWithHoles	PolygonWithHolesType
	polygon with holes type associated to object

typedef Shape2dPolygonWithHolesPtr	PolygonWithHolesPtr
	shared pointer to polygon with holes

typedef Shape2dPolygonWithHolesConstPtr	PolygonWithHolesConstPtr
	shared pointer to polygon with holes

typedef Shape2dPolygonWithHolesConstColl	PolygonWithHolesConstColl
	collection of const polygon with holes

typedef Shape2dPolygonWithHolesColl	PolygonWithHolesColl
	collection of polygon with holes

typedef Shape2dPolygonWithHolesColl::iterator	PolygonWithHolesIterator
	iterator to collection of polygon with holes

Public Types inherited from ipsdk::geom::BaseTypedGeometryEntity2d< Shape2dDataType >
typedef Shape2dDataType	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

void	clear ()
	method allowing all data associated to shape

Constructors and destructors
	Shape2d ()

	~Shape2d ()

Access to row intersections informations
bool	hasRowIntersections () const
	check whether row intersections have been set

const RowIntersections &	getRowIntersections () const
	retrieve row intersections collection

RowIntersections &	getRowIntersections ()
	access to row intersections collection

ipUInt64	getStartY () const
	retrieve starting row index for shape

ipUInt64	getSizeY () const
	retrieve number of rows associated to shape

ipUInt64	getEndY () const
	retrieve ending row index for shape

bool	hasRowIntersection (const ipUInt64 rowIdx) const
	check whether shape has an intersection with a given row

const RowSegments &	getRowIntersections (const ipUInt64 rowIdx) const

const ipUInt64	getNbPixels () const
	retrieve number of pixels associated to shape

void	clearRowIntersections ()
	method allowing to clear row intersections

Access to polygon with holes collection informations
bool	isPolygonWithHolesCollSet () const
	check whether polygon with holes collection has been set

const PolygonWithHolesConstColl &	getPolygonWithHolesColl () const
	access to polygon with holes collection

PolygonWithHolesColl &	getPolygonWithHolesColl ()
	retrieve polygon with holes collection

ipUInt64	getNbExteriorPoints () const
	retrieve number of exterior polygon points

ipUInt64	getNbTotPoints () const

PolygonWithHolesIterator	beginPolygonWithHoles ()
	iterator used to parse polygon

PolygonWithHolesIterator	endPolygonWithHoles ()
	iterator used to parse polygon

void	clearPolygonWithHolesColl ()
	method allowing to polygon with holes collection

Public Member Functions inherited from ipsdk::geom::BaseTypedGeometryEntity2d< Shape2dDataType >
	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 eSklSrzMode &	getSerializationMode () 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 BaseDynamicObject *	createNew () 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 BaseDynamicObject *	duplicate () 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_Shape
	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
RowIntersections	_rowIntersections
	structure describing shape/row intersections

PolygonWithHolesColl	_polygonWithHolesColl
	collection of polygon holes associated to shape 2d

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

Shape 2d associated to one or more closed polygon 2d.

Author: E. Noirfalise

Date: 2015/04/29

Copyright: 2015 Reactiv'IP, all right reserved.

Each polygon can be associated to one or more closed polygon which represent holes into top level polygon. Polygons should not intersect.

Member Function Documentation

◆ getRowIntersections()

const RowSegments& ipsdk::geom::Shape2d::getRowIntersections ( const ipUInt64 rowIdx ) const

access to row intersection for a given row index

Exceptions

ipsdk::geom::IPSDKGeometryException if hasRowIntersection(rowIdx) == false

◆ getNbTotPoints()

ipUInt64 ipsdk::geom::Shape2d::getNbTotPoints ( ) const

retrieve total number of polygon points (included holes points)

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKGeometry/Entity/2d/Shape/Shape2d.h

Public Types

Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getRowIntersections()

◆ getNbTotPoints()