pcl::octree::OctreeKey Class Reference

**Octree** key class
More...

`#include <octree_key.h>`

## Public Member Functions | |

unsigned char | getChildIdxWithDepthMask (unsigned int depthMask) const |

get child node index using depthMask | |

OctreeKey () | |

Empty constructor. | |

OctreeKey (unsigned int keyX, unsigned int keyY, unsigned int keyZ) | |

Constructor for key initialization. | |

OctreeKey (const OctreeKey &source) | |

Copy constructor. | |

bool | operator<= (const OctreeKey &b) const |

Operator<= for comparing octree keys with each other. | |

bool | operator== (const OctreeKey &b) const |

Operator== for comparing octree keys with each other. | |

bool | operator>= (const OctreeKey &b) const |

Operator>= for comparing octree keys with each other. | |

void | popBranch () |

pop child node from octree key | |

void | pushBranch (unsigned char childIndex) |

push a child node to the octree key | |

## Public Attributes | |

unsigned int | x |

unsigned int | y |

unsigned int | z |

**Octree** key class

**Note:**- Octree keys contain integer indices for each coordinate axis in order to address an octree leaf node.

Definition at line 51 of file octree_key.h.

pcl::octree::OctreeKey::OctreeKey | ( | ) | ` [inline]` |

Empty constructor.

Definition at line 56 of file octree_key.h.

pcl::octree::OctreeKey::OctreeKey | ( | unsigned int | keyX, |

unsigned int | keyY, |
||

unsigned int | keyZ |
||

) | ` [inline]` |

Constructor for key initialization.

Definition at line 62 of file octree_key.h.

pcl::octree::OctreeKey::OctreeKey | ( | const OctreeKey & | source | ) | ` [inline]` |

Copy constructor.

Definition at line 68 of file octree_key.h.

unsigned char pcl::octree::OctreeKey::getChildIdxWithDepthMask | ( | unsigned int | depthMask | ) | const` [inline]` |

get child node index using depthMask

**Parameters:**-
[in] depthMask bit mask with single bit set at query depth

**Returns:**- child node index

Definition at line 126 of file octree_key.h.

bool pcl::octree::OctreeKey::operator<= | ( | const OctreeKey & | b | ) | const` [inline]` |

Operator<= for comparing octree keys with each other.

**Returns:**- "true" if key indices are not greater than the key indices of b ; "false" otherwise.

Definition at line 86 of file octree_key.h.

bool pcl::octree::OctreeKey::operator== | ( | const OctreeKey & | b | ) | const` [inline]` |

Operator== for comparing octree keys with each other.

**Returns:**- "true" if leaf node indices are identical; "false" otherwise.

Definition at line 77 of file octree_key.h.

bool pcl::octree::OctreeKey::operator>= | ( | const OctreeKey & | b | ) | const` [inline]` |

Operator>= for comparing octree keys with each other.

**Returns:**- "true" if key indices are not smaller than the key indices of b ; "false" otherwise.

Definition at line 95 of file octree_key.h.

void pcl::octree::OctreeKey::popBranch | ( | ) | ` [inline]` |

pop child node from octree key

Definition at line 114 of file octree_key.h.

void pcl::octree::OctreeKey::pushBranch | ( | unsigned char | childIndex | ) | ` [inline]` |

push a child node to the octree key

**Parameters:**-
[in] childIndex index of child node to be added (0-7)

Definition at line 104 of file octree_key.h.

unsigned int pcl::octree::OctreeKey::x |

Definition at line 134 of file octree_key.h.

unsigned int pcl::octree::OctreeKey::y |

Definition at line 135 of file octree_key.h.

unsigned int pcl::octree::OctreeKey::z |

Definition at line 136 of file octree_key.h.

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