collection of 3d voxels More...

#include <Voxels3d.h>

Inheritance diagram for ipsdk::imaproc::attr::Voxels3d:

Public Member Functions
const std::string &	getObjectName () const
	method allowing to retrieve object name

const std::string &	getToolTip () const
	method allowing to retrieve object tooltip

const boost::filesystem::path	getHeaderPath () const
	retrieve relative header path associated to data item node

const std::string	getLibraryName () const
	retrieve library name associated data item node

const ipsdk::ItemNames &	getItemIds () const
	retrieve item associated to a given id More...

	~Voxels3d ()
	public destructor

Methods associated to sub node Coll
template<>
const ipsdk::DataItemNodeColl< ipsdk::imaproc::attr::Voxel3d > &	getNode () const
	access to sub node Coll

template<>
ipsdk::DataItemNodeColl< ipsdk::imaproc::attr::Voxel3d > &	get ()
	access to sub node Coll

template<>
const std::vector< ipsdk::imaproc::attr::Voxel3d > &	getNodeColl () const
	access to node collection for sub node Coll

template<>
bool	isEmpty () const
	check wether collection is empty for sub node Coll

template<>
ipsdk::ipUInt32	getSize () const
	retrieve collection size for sub node Coll

const ipsdk::imaproc::attr::Voxel3d &	getNode (const ipsdk::ipUInt32 nodeIdx) const
	retrieve node associated to given index for sub node Coll More...

ipsdk::imaproc::attr::Voxel3d &	getNode (const ipsdk::ipUInt32 nodeIdx)
	retrieve node associated to given index for sub node Coll More...

template<>
void	push_back (const boost::shared_ptr< ipsdk::imaproc::attr::Voxel3d > &pItemNode)
	push back a new element into collection for sub node Coll More...

template<>
void	clear ()
	remove all items from collection for sub node Coll

Public Member Functions inherited from ipsdk::BaseDataItemNode
eDataItemType	getDataItemType () const

bool	existsItem (const std::string &itemId) const

const BaseDataItem &	getItem (const std::string &itemId) const

const std::string &	getItemName (const std::string &itemId) const

const std::string &	getItemToolTip (const std::string &itemId) const

Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string &	getClassName () const

virtual BaseDynamicObject *	createNew () const=0

virtual DynamicObjectPtr	createShared () const=0

virtual bool	hasCopySupport () const=0

virtual BaseDynamicObject *	duplicate () const=0

virtual DynamicObjectPtr	duplicateShared () const=0

Static Public Member Functions
static const std::string &	getObjectNameStr ()
	method allowing to retrieve object name

static const std::string &	getToolTipStr ()
	method allowing to retrieve object tooltip

static const boost::filesystem::path	getHeaderPathStr ()
	retrieve relative header path associated to data item node

static const std::string	getLibraryNameStr ()
	retrieve library name associated data item node

static boost::shared_ptr< Voxels3d >	createNode ()
	node creation function

Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32	getVersion ()

Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string &	getTypeName ()

Static Public Attributes
static const ipsdk::ipUInt32	g_nbChildNodes
	number of child nodes associated to object

Static Public Attributes inherited from ipsdk::BaseDataItemNode
static const bool	g_bIsColl

static const bool	g_bNode

static const bool	g_bLeaf

static const eDataItemType::domain	g_itemType

Protected Member Functions
	Voxels3d ()
	protected constructor

Protected Member Functions inherited from ipsdk::BaseDataItemNode
virtual ItemInfoPtr	getItemInfo (const std::string &itemId) const=0

Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult	write (BaseOArchive &ar) const

virtual BoolResult	read (BaseIArchive &ar)

Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void	initCtorCopy (const BaseDynamicObject &object)

virtual void	copy (const BaseDynamicObject &object)

Additional Inherited Members
Protected Types inherited from ipsdk::BaseDataItemNode
typedef boost::shared_ptr< ItemInfo >	ItemInfoPtr

Detailed Description

collection of 3d voxels

Author: R. Abbal

Date: 2016/07/15

Copyright: 2016 Reactiv'IP, all right reserved.

Node associated library :

IPSDKIPLAttributes

SubNodes description

Name	ToolTip	Associated Class	Default Value
Coll	position and intensity of a 3d voxel	ipsdk::DataItemNodeColl<ipsdk::imaproc::attr::Voxel3d>

Member Function Documentation

◆ getItemIds()

const ipsdk::ItemNames& ipsdk::imaproc::attr::Voxels3d::getItemIds ( ) const

virtual

retrieve item associated to a given id

Exceptions

ipsdk::IPSDKBaseDataException if existsItem(itemName) == false

Implements ipsdk::BaseDataItemNode.

◆ getNode() [1/2]

const ipsdk::imaproc::attr::Voxel3d& ipsdk::imaproc::attr::Voxels3d::getNode ( const ipsdk::ipUInt32 nodeIdx ) const

retrieve node associated to given index for sub node Coll

Exceptions

ipsdk::IPSDKBaseDataException if nodeIdx >= getSize()

◆ getNode() [2/2]

ipsdk::imaproc::attr::Voxel3d& ipsdk::imaproc::attr::Voxels3d::getNode ( const ipsdk::ipUInt32 nodeIdx )

retrieve node associated to given index for sub node Coll

Exceptions

ipsdk::IPSDKBaseDataException if nodeIdx >= getSize()

◆ push_back()

template<>

void ipsdk::imaproc::attr::Voxels3d::push_back ( const boost::shared_ptr< ipsdk::imaproc::attr::Voxel3d > & pItemNode )

push back a new element into collection for sub node Coll

Exceptions

ipsdk::IPSDKBaseDataException if pItemNode->get() == 0

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKIPL/IPSDKIPLAttributes/DataItem/Voxels3d.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Node associated library :

SubNodes description

Member Function Documentation

◆ getItemIds()

◆ getNode() [1/2]

◆ getNode() [2/2]

◆ push_back()