Classes | Typedefs | Enumerations | Variables
localTypes.h File Reference
#include <vector>
#include <boost/shared_ptr.hpp>
#include <boost/weak_ptr.hpp>
#include <pcl/point_types.h>
#include <pcl/point_cloud.h>
Include dependency graph for localTypes.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  IncIndex
 Simple functor that produces sequential integers from an initial value. More...

Typedefs

typedef unsigned int BitMask
 The type for bit masks used for recognizing key pressed by user.
typedef pcl::PointCloud< Point3DCloud3D
 The type used as internal representation of a cloud object.
typedef boost::shared_ptr< CloudCloudPtr
 The type for boost shared pointer pointing to a cloud object.
typedef boost::shared_ptr
< Command
CommandPtr
 The type for boost shared pointer pointing to a command object.
typedef boost::shared_ptr
< CommandQueue
CommandQueuePtr
typedef boost::shared_ptr
< const Cloud
ConstCloudPtr
typedef boost::shared_ptr
< const CopyBuffer
ConstCopyBufferPtr
typedef std::vector< const int > ConstIndexVector
typedef boost::shared_ptr
< const Selection
ConstSelectionPtr
typedef boost::shared_ptr
< CopyBuffer
CopyBufferPtr
 The type for boost shared pointer pointing to a copy buffer.
typedef std::vector< unsigned int > IndexVector
 The type used for vectors holding the indices of points in a cloud.
typedef Cloud3D::Ptr PclCloudPtr
 The type for boost shared pointer pointing to a PCL cloud object.
typedef pcl::PointXYZRGBA Point3D
 The type for the 3D points in the point cloud.
typedef boost::shared_ptr
< Selection
SelectionPtr
 The type for boost shared pointer pointing to a selection buffer.

Enumerations

enum  Axis { X, Y, Z }
enum  Color { RED, GREEN, BLUE, RGB }
 Indices for color components. More...
enum  ColorScheme {
  COLOR_BY_X = 0, COLOR_BY_Y, COLOR_BY_Z, COLOR_BY_RGB,
  COLOR_BY_PURE
}
enum  KeyModifier { NONE = 0x00000000, SHFT = 0x02000000, CTRL = 0x04000000, ALT = 0x08000000 }
 ID's for the key modifiers. More...
enum  MouseButton { NOBUTTON, LEFT, RIGHT }
 ID's for the mouse buttons. More...

Variables

const float DISPLAY_Z_TRANSLATION = -2.0f
const unsigned int MATRIX_SIZE = MATRIX_SIZE_DIM * MATRIX_SIZE_DIM
const unsigned int MATRIX_SIZE_DIM = 4
const float TRACKBALL_RADIUS_SCALE = 0.4f
 The radius of the trackball given as a percentage of the screen width.
const unsigned int WINDOW_HEIGHT = 1000
 The default window height.
const unsigned int WINDOW_WIDTH = 1200
 The default window width.
const unsigned int XYZ_SIZE = 3

Detailed Description

Copyright (c) 2012, Texas A&M University All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of Texas A&M University nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The following software was written as part of a collaboration with the University of South Carolina, Interdisciplinary Mathematics Institute.

A set of useful typedefs, forward declarations and constants.

Author:
Yue Li and Matthew Hielsberg

Definition in file localTypes.h.


Typedef Documentation

typedef unsigned int BitMask

The type for bit masks used for recognizing key pressed by user.

Definition at line 104 of file localTypes.h.

The type used as internal representation of a cloud object.

Definition at line 63 of file localTypes.h.

typedef boost::shared_ptr<Cloud> CloudPtr

The type for boost shared pointer pointing to a cloud object.

Definition at line 69 of file localTypes.h.

typedef boost::shared_ptr<Command> CommandPtr

The type for boost shared pointer pointing to a command object.

Definition at line 90 of file localTypes.h.

typedef boost::shared_ptr<CommandQueue> CommandQueuePtr

The type for boost shared pointer pointing to a command queue object

Definition at line 101 of file localTypes.h.

typedef boost::shared_ptr<const Cloud> ConstCloudPtr

The type for boost shared pointer pointing to a constant cloud object

Definition at line 73 of file localTypes.h.

typedef boost::shared_ptr<const CopyBuffer> ConstCopyBufferPtr

The type for boost shared pointer pointing to a constant copy buffer

Definition at line 87 of file localTypes.h.

typedef std::vector<const int> ConstIndexVector

The type used for vectors holding the constant indices of points in a cloud

Definition at line 97 of file localTypes.h.

typedef boost::shared_ptr<const Selection> ConstSelectionPtr

The type for boost shared pointer pointing to a constant selection buffer

Definition at line 80 of file localTypes.h.

typedef boost::shared_ptr<CopyBuffer> CopyBufferPtr

The type for boost shared pointer pointing to a copy buffer.

Definition at line 83 of file localTypes.h.

typedef std::vector<unsigned int> IndexVector

The type used for vectors holding the indices of points in a cloud.

Definition at line 93 of file localTypes.h.

The type for boost shared pointer pointing to a PCL cloud object.

Definition at line 66 of file localTypes.h.

The type for the 3D points in the point cloud.

Definition at line 55 of file localTypes.h.

typedef boost::shared_ptr<Selection> SelectionPtr

The type for boost shared pointer pointing to a selection buffer.

Definition at line 76 of file localTypes.h.


Enumeration Type Documentation

enum Axis

Indices for the coordinate axes It is assumed that the ColorScheme X,Y,Z match these values

Enumerator:
X 
Y 
Z 

Definition at line 125 of file localTypes.h.

enum Color

Indices for color components.

Enumerator:
RED 
GREEN 
BLUE 
RGB 

Definition at line 133 of file localTypes.h.

Scheme used for coloring the whole cloud. It is assumed that the Axiz X,Y,Z match the COLOR_BY_[X,Y,Z] values

Enumerator:
COLOR_BY_X 
COLOR_BY_Y 
COLOR_BY_Z 
COLOR_BY_RGB 
COLOR_BY_PURE 

Definition at line 143 of file localTypes.h.

ID's for the key modifiers.

Enumerator:
NONE 
SHFT 
CTRL 
ALT 

Definition at line 107 of file localTypes.h.

ID's for the mouse buttons.

Enumerator:
NOBUTTON 
LEFT 
RIGHT 

Definition at line 116 of file localTypes.h.


Variable Documentation

const float DISPLAY_Z_TRANSLATION = -2.0f

The default z translation used to push the world origin in front of the display

Definition at line 187 of file localTypes.h.

A helpful const representing the number of elements in our matrices. This is used for all operations that require the copying of the matrix.

Definition at line 178 of file localTypes.h.

const unsigned int MATRIX_SIZE_DIM = 4

A helpful const representing the number of elements in each row/col in our matrices. This is used for all operations that require the copying of the matrix.

Definition at line 174 of file localTypes.h.

const float TRACKBALL_RADIUS_SCALE = 0.4f

The radius of the trackball given as a percentage of the screen width.

Definition at line 190 of file localTypes.h.

const unsigned int WINDOW_HEIGHT = 1000

The default window height.

Definition at line 183 of file localTypes.h.

const unsigned int WINDOW_WIDTH = 1200

The default window width.

Definition at line 181 of file localTypes.h.

const unsigned int XYZ_SIZE = 3

A helpful const representing the number of elements in our vectors. This is used for all operations that require the copying of the vector. Although this is used in a fairly generic way, the display requires 3D.

Definition at line 169 of file localTypes.h.



pcl
Author(s): Open Perception
autogenerated on Wed Aug 26 2015 15:38:45