Abstract octree branch class More...

#include <pcl/octree/octree_nodes.h>

Inheritance diagram for pcl::octree::OctreeBranchNode< ContainerT >:

Collaboration diagram for pcl::octree::OctreeBranchNode< ContainerT >:

Public Member Functions
	OctreeBranchNode ()
	Empty constructor. More...

	OctreeBranchNode (const OctreeBranchNode &source)
	Empty constructor. More...

OctreeBranchNode &	operator= (const OctreeBranchNode &source)
	Copy operator. More...

virtual OctreeBranchNode *	deepCopy () const
	Octree deep copy method. More...

virtual	~OctreeBranchNode ()
	Empty deconstructor. More...

OctreeNode *&	operator[] (unsigned char child_idx_arg)
	Access operator. More...

OctreeNode *	getChildPtr (unsigned char child_idx_arg) const
	Get pointer to child. More...

void	setChildPtr (OctreeNode *child, unsigned char index)
	Get pointer to child. More...

bool	hasChild (unsigned char child_idx_arg) const
	Check if branch is pointing to a particular child node. More...

virtual node_type_t	getNodeType () const
	Check if branch can be pruned. More...

void	reset ()

const ContainerT *	operator-> () const
	Get const pointer to container. More...

ContainerT *	operator-> ()
	Get pointer to container. More...

const ContainerT &	operator* () const
	Get const reference to container. More...

ContainerT &	operator* ()
	Get reference to container. More...

const ContainerT &	getContainer () const
	Get const reference to container. More...

ContainerT &	getContainer ()
	Get reference to container. More...

const ContainerT *	getContainerPtr () const
	Get const pointer to container. More...

ContainerT *	getContainerPtr ()
	Get pointer to container. More...

Public Member Functions inherited from pcl::octree::OctreeNode
	OctreeNode ()

virtual	~OctreeNode ()

Protected Attributes
OctreeNode *	child_node_array_ [8]

ContainerT	container_

Detailed Description

template<typename ContainerT>
class pcl::octree::OctreeBranchNode< ContainerT >

Abstract octree branch class

Note: Octree branch classes may collect data of type DataT

Author: Julius Kammerl (juliu.nosp@m.s@ka.nosp@m.mmerl.nosp@m..de)

Definition at line 207 of file octree_nodes.h.

Constructor & Destructor Documentation

template<typename ContainerT >

pcl::octree::OctreeBranchNode< ContainerT >::OctreeBranchNode ( )

inline

Empty constructor.

Definition at line 212 of file octree_nodes.h.

References pcl::octree::OctreeBranchNode< ContainerT >::child_node_array_.

template<typename ContainerT >

pcl::octree::OctreeBranchNode< ContainerT >::OctreeBranchNode ( const OctreeBranchNode< ContainerT > & source )

inline

Empty constructor.

Definition at line 220 of file octree_nodes.h.

References pcl::octree::OctreeBranchNode< ContainerT >::child_node_array_, and pcl::octree::OctreeNode::deepCopy().

template<typename ContainerT >

virtual pcl::octree::OctreeBranchNode< ContainerT >::~OctreeBranchNode ( )

inlinevirtual

Empty deconstructor.

Definition at line 255 of file octree_nodes.h.

Member Function Documentation

template<typename ContainerT >

virtual OctreeBranchNode* pcl::octree::OctreeBranchNode< ContainerT >::deepCopy ( ) const

inlinevirtual

Octree deep copy method.

Implements pcl::octree::OctreeNode.

Definition at line 248 of file octree_nodes.h.

template<typename ContainerT >

OctreeNode* pcl::octree::OctreeBranchNode< ContainerT >::getChildPtr ( unsigned char child_idx_arg ) const

inline

Get pointer to child.

Parameters

child_idx_arg,: index to child node

Returns: OctreeNode pointer

Definition at line 275 of file octree_nodes.h.

References pcl::octree::OctreeBranchNode< ContainerT >::child_node_array_.

Referenced by pcl::octree::OctreeBase< LeafContainerT, BranchContainerT >::branchHasChild(), pcl::octree::OctreeBase< LeafContainerT, BranchContainerT >::getBranchBitPattern(), pcl::octree::OctreeBase< LeafContainerT, BranchContainerT >::getBranchChildPtr(), pcl::octree::OctreePointCloudVoxelCentroid< PointT, LeafContainerT, BranchContainerT >::getVoxelCentroidsRecursive(), and pcl::octree::OctreeBase< LeafContainerT, BranchContainerT >::serializeTreeRecursive().

template<typename ContainerT >

const ContainerT& pcl::octree::OctreeBranchNode< ContainerT >::getContainer ( ) const

inline

Get const reference to container.

Definition at line 369 of file octree_nodes.h.

References pcl::octree::OctreeBranchNode< ContainerT >::container_.

template<typename ContainerT >

ContainerT& pcl::octree::OctreeBranchNode< ContainerT >::getContainer ( )

inline

Get reference to container.

Definition at line 376 of file octree_nodes.h.

References pcl::octree::OctreeBranchNode< ContainerT >::container_.

template<typename ContainerT >

const ContainerT* pcl::octree::OctreeBranchNode< ContainerT >::getContainerPtr ( ) const

inline

Get const pointer to container.

Definition at line 383 of file octree_nodes.h.

References pcl::octree::OctreeBranchNode< ContainerT >::container_.

template<typename ContainerT >

ContainerT* pcl::octree::OctreeBranchNode< ContainerT >::getContainerPtr ( )

inline

Get pointer to container.

Definition at line 390 of file octree_nodes.h.

References pcl::octree::OctreeBranchNode< ContainerT >::container_.

template<typename ContainerT >

virtual node_type_t pcl::octree::OctreeBranchNode< ContainerT >::getNodeType ( ) const

inlinevirtual

Check if branch can be pruned.

Note: if all children are leaf nodes AND contain identical containers, branch can be pruned

Returns: "true" if branch can be pruned; "false" otherwiseGet the type of octree node. Returns LEAVE_NODE type

Implements pcl::octree::OctreeNode.

Definition at line 326 of file octree_nodes.h.

References pcl::octree::BRANCH_NODE.

template<typename ContainerT >

bool pcl::octree::OctreeBranchNode< ContainerT >::hasChild ( unsigned char child_idx_arg ) const

inline

Check if branch is pointing to a particular child node.

Parameters

child_idx_arg,: index to child node

Returns: "true" if pointer to child node exists; "false" otherwise

Definition at line 295 of file octree_nodes.h.

References pcl::octree::OctreeBranchNode< ContainerT >::child_node_array_.

Referenced by pcl::octree::OctreeBase< LeafContainerT, BranchContainerT >::deleteBranchChild(), pcl::octree::OctreeBase< LeafContainerT, BranchContainerT >::deleteLeafRecursive(), pcl::octree::OctreePointCloudVoxelCentroid< PointT, LeafContainerT, BranchContainerT >::getVoxelCentroidsRecursive(), and pcl::octree::OctreeBase< LeafContainerT, BranchContainerT >::serializeTreeRecursive().

template<typename ContainerT >

const ContainerT& pcl::octree::OctreeBranchNode< ContainerT >::operator* ( ) const

inline

Get const reference to container.

Definition at line 355 of file octree_nodes.h.

References pcl::octree::OctreeBranchNode< ContainerT >::container_.

template<typename ContainerT >

ContainerT& pcl::octree::OctreeBranchNode< ContainerT >::operator* ( )

inline

Get reference to container.

Definition at line 362 of file octree_nodes.h.

References pcl::octree::OctreeBranchNode< ContainerT >::container_.

template<typename ContainerT >

const ContainerT* pcl::octree::OctreeBranchNode< ContainerT >::operator-> ( ) const

inline

Get const pointer to container.

Definition at line 341 of file octree_nodes.h.

References pcl::octree::OctreeBranchNode< ContainerT >::container_.

template<typename ContainerT >

ContainerT* pcl::octree::OctreeBranchNode< ContainerT >::operator-> ( )

inline

Get pointer to container.

Definition at line 348 of file octree_nodes.h.

References pcl::octree::OctreeBranchNode< ContainerT >::container_.

template<typename ContainerT >

OctreeBranchNode& pcl::octree::OctreeBranchNode< ContainerT >::operator= ( const OctreeBranchNode< ContainerT > & source )

inline

Copy operator.

Definition at line 234 of file octree_nodes.h.

References pcl::octree::OctreeBranchNode< ContainerT >::child_node_array_, and pcl::octree::OctreeNode::deepCopy().

template<typename ContainerT >

OctreeNode*& pcl::octree::OctreeBranchNode< ContainerT >::operator[] ( unsigned char child_idx_arg )

inline

Access operator.

Parameters

child_idx_arg,: index to child node

Returns: OctreeNode pointer

Definition at line 264 of file octree_nodes.h.

References pcl::octree::OctreeBranchNode< ContainerT >::child_node_array_.

template<typename ContainerT >

void pcl::octree::OctreeBranchNode< ContainerT >::reset ( )

inline

Definition at line 332 of file octree_nodes.h.

References pcl::octree::OctreeBranchNode< ContainerT >::child_node_array_, and pcl::octree::OctreeBranchNode< ContainerT >::container_.

template<typename ContainerT >

void pcl::octree::OctreeBranchNode< ContainerT >::setChildPtr	(	OctreeNode *	child,
		unsigned char	index
	)

inline

Get pointer to child.

Returns: OctreeNode pointer

Definition at line 284 of file octree_nodes.h.

References pcl::octree::OctreeBranchNode< ContainerT >::child_node_array_.

Member Data Documentation

template<typename ContainerT >

OctreeNode* pcl::octree::OctreeBranchNode< ContainerT >::child_node_array_[8]

protected

Definition at line 396 of file octree_nodes.h.

Referenced by pcl::octree::OctreeBranchNode< ContainerT >::getChildPtr(), pcl::octree::OctreeBranchNode< ContainerT >::hasChild(), pcl::octree::OctreeBranchNode< ContainerT >::OctreeBranchNode(), pcl::octree::OctreeBranchNode< ContainerT >::operator=(), pcl::octree::OctreeBranchNode< ContainerT >::operator[](), pcl::octree::OctreeBranchNode< ContainerT >::reset(), and pcl::octree::OctreeBranchNode< ContainerT >::setChildPtr().

template<typename ContainerT >

ContainerT pcl::octree::OctreeBranchNode< ContainerT >::container_

protected

Definition at line 398 of file octree_nodes.h.

Referenced by pcl::octree::OctreeBranchNode< ContainerT >::getContainer(), pcl::octree::OctreeBranchNode< ContainerT >::getContainerPtr(), pcl::octree::OctreeBranchNode< ContainerT >::operator*(), pcl::octree::OctreeBranchNode< ContainerT >::operator->(), and pcl::octree::OctreeBranchNode< ContainerT >::reset().

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

/builddir/build/BUILD/pcl-0ddf11a6ad1175b6f1c253da003de20c1295cde0/octree/include/pcl/octree/octree_nodes.h

Public Member Functions

Protected Attributes

Detailed Description

template<typename ContainerT> class pcl::octree::OctreeBranchNode< ContainerT >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename ContainerT>
class pcl::octree::OctreeBranchNode< ContainerT >