documentation.HELP! OpenNI Documentation

OpenNI 1.5.4

OpenNI

Table of contents

• OpenNI Overview
  • Introduction
  • Concepts
    • Contexts
    • The Production Graph
    • Reference Counting
    • Data Generation
    • Making Data Available using the WaitXUpdateAll() Methods
    • Capabilities Mechanism
    • Coordinate Systems
    • Map Wrapper Classes
    • Frame Objects and Metadata Objects
    • Sharing Devices Between Applications and Locking Nodes
    • Global Mirror
    • Global Error State
    • Events and Handlers
    • Licenses
    • Recordings
    • Mock Nodes
  • Xml Scripts
  • Command-Line Utilities
    • niReg
    • niLicense
  • Additional Utilities
  • Getting Started - A Tutorial
    • Building and running a sample application
    • Creating an empty project that uses OpenNI
    • Error codes
    • Basic Functions: initialize, create a node and read data
    • Enumerating possible production chains
    • Understanding why enumeration failed
    • Configuring nodes
    • Configuring OpenNI using an XML file
    • Playing a file recording
    • Recording data
  • Samples and Guides
    • Sample Programs for the OpenNI API
      • NiAudioSample.cpp - sample program
      • NiBackRecorder.cpp - sample program
      • NiConvertXToONI.cpp - sample program
      • NiRecordRaw.cpp - sample program
      • NiRecordSynthetic.cpp - sample program
      • NiSimpleCreate.cpp - sample program
      • NiSimpleRead.cpp - sample program
      • NiSimpleViewer.cpp - sample program
      • NiUserTracker - sample program
      • NiViewer - sample program
        • Capture.cpp file
        • Device.cpp file
        • Draw.cpp file
        • Statistics.cpp file
      • SimpleRead.java - sample program (Java)
      • SimpleRead.net - sample program (C#/.NET)
      • SimpleViewer.java - sample program (Java)
      • SimpleViewer.net - sample program (C#/.NET)
      • UserTracker.java - sample program (Java)
      • UserTracker.net - sample program (C#)
      • HandTracker.java - sample program (java)
    • Guides for OpenNI Development
      • Creating OpenNI Modules
        • Defining the Node Topology
        • Creating a Node Implementation
          • Implement the Proper Interface
          • Obtain Inputs
          • Support Capabilities
          • Implementing a Generator
        • Creating a Node Exporter
        • Module Entry Points
        • Registering the new Module
  • Glossary
  • Legal Stuff & Acknowledgments
• Modules
  • C Reference
    • Context
    • Production Node Info
    • Production Node Info List
    • Queries
    • Enumeration Errors
    • Production Nodes Functionality
      • Production Node
        • Error State Capability
        • General Int Capability
      • Device
        • Device Identification Capability
      • Generator
        • Mirror Capability
        • Alternative View Point Capability
        • Frame-Sync Capability
      • Map Generator
        • Cropping Capability
        • Anti Flicker Capability
      • Depth Generator
        • User Position Capability
      • Image Generator
      • IR Generator
      • Gesture Generator
      • Scene Analyzer
      • User Generator
        • Skeleton Capability
        • Pose Detection Capability
        • Hand Touching FOV Edge Capability
      • Hands Generator
      • Audio Generator
      • Mock Nodes
      • Codec
      • Recorder
      • Player
      • Script Node
    • Licenses
    • Utilities
  • C++ Reference to Application Programmer Interface (API)
    • Global Event Handlers
    • Managing the Production Graph
    • Meta-Data Objects (Frame Objects)
    • Production Nodes Functionality
    • Misc
• Class List
  • xn::AlternativeViewPointCapability
  • xn::AntiFlickerCapability
  • xn::AudioGenerator
  • xn::AudioMetaData
  • xn::Capability
  • xn::Codec
  • XnHash::ConstIterator
  • XnHashT< TKey, TValue, TKeyManager, TAlloc >::ConstIterator
  • XnList::ConstIterator
  • XnListT< T, TAlloc >::ConstIterator
  • xn::Context
  • xn::CroppingCapability
  • xn::DepthGenerator
  • xn::DepthMetaData
  • xn::Device
  • xn::DeviceIdentificationCapability
  • xn::EnumerationErrors
  • xn::ErrorStateCapability
  • xn::ExtensionModule
  • xn::FrameSyncCapability
  • xn::GeneralIntCapability
  • xn::Generator
  • xn::GestureGenerator
  • xn::HandsGenerator
  • xn::HandTouchingFOVEdgeCapability
  • xn::ImageGenerator
  • xn::ImageMetaData
  • INiNodeAllocator
  • xn::IRGenerator
  • xn::IRMetaData
  • xn::EnumerationErrors::Iterator
  • xn::NodeInfoList::Iterator
  • XnHash::Iterator
  • XnHashT< TKey, TValue, TKeyManager, TAlloc >::Iterator
  • XnList::Iterator
  • XnListT< T, TAlloc >::Iterator
  • xn::Map< _pixelType >
  • xn::MapGenerator
  • xn::MapMetaData
  • xn::MirrorCapability
  • xn::MockAudioGenerator
  • xn::MockDepthGenerator
  • xn::MockImageGenerator
  • xn::MockIRGenerator
  • xn::MockRawGenerator
  • xn::Module
  • xn::ModuleAlternativeViewPointInterface
  • xn::ModuleAntiFlickerInterface
  • xn::ModuleAudioGenerator
  • xn::ModuleCodec
  • xn::ModuleCroppingInterface
  • xn::ModuleDepthGenerator
  • xn::ModuleDevice
  • xn::ModuleDeviceIdentificationInterface
  • xn::ModuleErrorStateInterface
  • xn::ModuleExportedProductionNode
  • xn::ModuleExtendedSerializationInterface
  • xn::ModuleFrameSyncInterface
  • xn::ModuleGeneralIntInterface
  • xn::ModuleGenerator
  • xn::ModuleGestureGenerator
  • xn::ModuleHandsGenerator
  • xn::ModuleHandTouchingFOVEdgeInterface
  • xn::ModuleImageGenerator
  • xn::ModuleIRGenerator
  • xn::ModuleLockAwareInterface
  • xn::ModuleMapGenerator
  • xn::ModuleMirrorInterface
  • xn::ModuleNodeNotifications
  • xn::ModulePlayer
  • xn::ModulePoseDetectionInteface
  • xn::ModuleProductionNode
  • xn::ModuleRecorder
  • xn::ModuleSceneAnalyzer
  • xn::ModuleScriptNode
  • xn::ModuleSkeletonInterface
  • xn::ModuleUserGenerator
  • xn::ModuleUserPositionInterface
  • xn::NodeInfo
  • xn::NodeInfoList
  • xn::NodeWrapper
  • xn::OutputMetaData
  • xn::Player
  • xn::PoseDetectionCapability
  • xn::ProductionNode
  • xn::Query
  • xn::Recorder
  • xn::Resolution
  • xn::SceneAnalyzer
  • xn::SceneMetaData
  • xn::ScriptNode
  • xn::SkeletonCapability
  • xn::StateChangedCallbackTranslator
  • xn::UserGenerator
  • xn::UserPositionCapability
  • xn::Version
  • XnAlgorithms
  • XnArray< T >
  • XnAudioMetaData
  • XnAutoCSLocker
  • XnAutoMutexLocker
  • XnBaseNode
  • XnBitSet
  • XnBoundingBox3D
  • XnCallback
  • XnCallbackT< FuncPtr >
  • XnCropping
  • XnCyclicQueueT< T, TDefaultMaxDepth, TAlloc >
  • XnCyclicStackT< T, TDefaultMaxDepth, TAlloc >
  • XnDefaultKeyManagerT< TKey >
  • XnDepthMetaData
  • XnDumpWriter
  • XnDumpWriterFileHandle
  • XnErrorCodeData
  • XnEvent
  • XnEvent1Arg< TArg1 >
  • XnEvent2Args< TArg1, TArg2 >
  • XnEvent3Args< TArg1, TArg2, TArg3 >
  • XnEvent4Args< TArg1, TArg2, TArg3, TArg4 >
  • XnEvent5Args< TArg1, TArg2, TArg3, TArg4, TArg5 >
  • XnEventInterface
  • XnEventInterfaceT< FuncPtr >
  • XnEventNoArgs
  • XnEventT< TEventArgs >
  • XnFieldOfView
  • XnGeneralBuffer
  • XnHandlerFunc1Arg< TArg1 >
  • XnHandlerFunc2Args< TArg1, TArg2 >
  • XnHandlerFunc3Args< TArg1, TArg2, TArg3 >
  • XnHandlerFunc4Args< TArg1, TArg2, TArg3, TArg4 >
  • XnHandlerFunc5Args< TArg1, TArg2, TArg3, TArg4, TArg5 >
  • XnHandlerFuncNoArgs
  • XnHash
  • XnHashT< TKey, TValue, TKeyManager, TAlloc >
  • XnImageMetaData
  • XnIRMetaData
  • XnKeyValuePair< _TKey, _TValue >
  • XnLicense
  • XnLinkedNodeDefaultAllocatorT< T >
  • XnLinkedNodeT< T >
  • XnList
  • XnListT< T, TAlloc >
  • XnLogEntry
  • XnLogger
  • XnLogWriter
  • XnLogWriterBase
  • XnMapMetaData
  • XnMapOutputMode
  • XnMatrix3X3
  • XnModuleAlternativeViewPointInterface
  • XnModuleAntiFlickerInterface
  • XnModuleAudioGeneratorInterface
  • XnModuleCodecInterface
  • XnModuleCroppingInterface
  • XnModuleDepthGeneratorInterface
  • XnModuleDeviceIdentificationInterface
  • XnModuleDeviceInterface
  • XnModuleErrorStateInterface
  • XnModuleExportedProductionNodeInterface
  • XnModuleExtendedSerializationInterface
  • XnModuleFrameSyncInterface
  • XnModuleGeneralIntInterface
  • XnModuleGeneratorInterface
  • XnModuleGestureGeneratorInterface
  • XnModuleHandsGeneratorInterface
  • XnModuleHandTouchingFOVEdgeCapabilityInterface
  • XnModuleImageGeneratorInterface
  • XnModuleIRGeneratorInterface
  • XnModuleLockAwareInterface
  • XnModuleMapGeneratorInterface
  • XnModuleMirrorInterface
  • XnModulePlayerInterface
  • XnModulePoseDetectionCapabilityInterface
  • XnModuleProductionNodeInterface
  • XnModuleRecorderInterface
  • XnModuleSceneAnalyzerInterface
  • XnModuleScriptNodeInterface
  • XnModuleSkeletonCapabilityInterface
  • XnModuleUserGeneratorInterface
  • XnModuleUserPositionCapabilityInterface
  • XnNode
  • XnNodeAllocator
  • XnNodeInfoListIterator
  • XnNodeNotifications
  • XnOpenNIModuleInterface
  • XnOSEvent
  • xnOSInfo
  • XnOutputMetaData
  • XnPlane3D
  • XnPlayerInputStreamInterface
  • XnProductionNodeDescription
  • XnQueue
  • XnQueueT< T, TAlloc >
  • XnRecorderOutputStreamInterface
  • XnRGB24Pixel
  • XnSceneMetaData
  • XnSkeletonJointOrientation
  • XnSkeletonJointPosition
  • XnSkeletonJointTransformation
  • XnStack
  • XnStackT< T, TAlloc >
  • XnStringsHashKeyManager
  • XnStringsHashT< TValue >
  • XnStringsKeyManager
  • XnStringsKeyTranslator
  • XnStringsNodeAllocator< TValue >
  • XnStringsSet
  • XnSupportedPixelFormats
  • XnThreadSafeQueue
  • XnUInt32XYPair
  • XnUSBConfigDescriptorHolder
  • XnUSBDeviceDescriptorHolder
  • XnUSBEventArgs
  • XnUSBInterfaceDescriptorHolder
  • XnUSBStringDescriptor
  • XnVector3D
  • XnVersion
  • XnWaveOutputMode
  • XnYUV422DoublePixel
• Class Index
• Class Hierarchy
  • XnHash::ConstIterator
    • XnHash::Iterator
  • XnHashT< TKey, TValue, TKeyManager, TAlloc >::ConstIterator
    • XnHashT< TKey, TValue, TKeyManager, TAlloc >::Iterator
  • XnList::ConstIterator
    • XnList::Iterator
  • XnListT< T, TAlloc >::ConstIterator
    • XnListT< T, TAlloc >::Iterator
  • xn::Context
  • xn::EnumerationErrors
  • INiNodeAllocator
    • XnNodeAllocator
  • xn::EnumerationErrors::Iterator
  • xn::NodeInfoList::Iterator
  • xn::Map< _pixelType >
  • xn::Module
    • xn::ExtensionModule
  • xn::ModuleAlternativeViewPointInterface
  • xn::ModuleAntiFlickerInterface
  • xn::ModuleCroppingInterface
  • xn::ModuleDeviceIdentificationInterface
  • xn::ModuleErrorStateInterface
  • xn::ModuleExportedProductionNode
  • xn::ModuleExtendedSerializationInterface
  • xn::ModuleFrameSyncInterface
  • xn::ModuleGeneralIntInterface
  • xn::ModuleHandTouchingFOVEdgeInterface
  • xn::ModuleLockAwareInterface
  • xn::ModuleMirrorInterface
  • xn::ModuleNodeNotifications
    • xn::ModuleRecorder
  • xn::ModulePoseDetectionInteface
  • xn::ModuleProductionNode
    • xn::ModuleCodec
    • xn::ModuleDevice
    • xn::ModuleGenerator
      • xn::ModuleAudioGenerator
      • xn::ModuleGestureGenerator
      • xn::ModuleHandsGenerator
      • xn::ModuleMapGenerator
        • xn::ModuleDepthGenerator
        • xn::ModuleImageGenerator
        • xn::ModuleIRGenerator
        • xn::ModuleSceneAnalyzer
      • xn::ModuleUserGenerator
    • xn::ModulePlayer
    • xn::ModuleRecorder
    • xn::ModuleScriptNode
  • xn::ModuleSkeletonInterface
  • xn::ModuleUserPositionInterface
  • xn::NodeInfo
  • xn::NodeInfoList
  • xn::NodeWrapper
    • xn::Capability
      • xn::AlternativeViewPointCapability
      • xn::AntiFlickerCapability
      • xn::CroppingCapability
      • xn::DeviceIdentificationCapability
      • xn::ErrorStateCapability
      • xn::FrameSyncCapability
      • xn::GeneralIntCapability
      • xn::HandTouchingFOVEdgeCapability
      • xn::MirrorCapability
      • xn::PoseDetectionCapability
      • xn::SkeletonCapability
      • xn::UserPositionCapability
    • xn::ProductionNode
      • xn::Codec
      • xn::Device
      • xn::Generator
        • xn::AudioGenerator
          • xn::MockAudioGenerator
        • xn::GestureGenerator
        • xn::HandsGenerator
        • xn::MapGenerator
          • xn::DepthGenerator
            • xn::MockDepthGenerator
          • xn::ImageGenerator
            • xn::MockImageGenerator
          • xn::IRGenerator
            • xn::MockIRGenerator
          • xn::SceneAnalyzer
        • xn::MockRawGenerator
        • xn::UserGenerator
      • xn::Player
      • xn::Recorder
      • xn::ScriptNode
  • xn::OutputMetaData
    • xn::AudioMetaData
    • xn::MapMetaData
      • xn::DepthMetaData
      • xn::ImageMetaData
      • xn::IRMetaData
      • xn::SceneMetaData
  • xn::Query
  • xn::Resolution
  • xn::StateChangedCallbackTranslator
  • xn::Version
  • XnAlgorithms
  • XnArray< T >
  • XnAudioMetaData
  • XnAutoCSLocker
  • XnAutoMutexLocker
  • XnBaseNode
    • XnNode
  • XnBitSet
  • XnBoundingBox3D
  • XnCallback
  • XnCallbackT< FuncPtr >
  • XnCropping
  • XnDefaultKeyManagerT< TKey >
  • XnDepthMetaData
  • XnDumpWriter
  • XnDumpWriterFileHandle
  • XnErrorCodeData
  • XnEventInterface
    • XnEvent
  • XnEventInterfaceT< FuncPtr >
  • XnEventInterfaceT< XnHandlerFunc1Arg< const TEventArgs & >::FuncPtr >
    • XnEvent1Arg< const TEventArgs & >
      • XnEventT< TEventArgs >
  • XnEventInterfaceT< XnHandlerFunc1Arg< TArg1 >::FuncPtr >
    • XnEvent1Arg< TArg1 >
  • XnEventInterfaceT< XnHandlerFunc2Args< TArg1, TArg2 >::FuncPtr >
    • XnEvent2Args< TArg1, TArg2 >
  • XnEventInterfaceT< XnHandlerFunc3Args< TArg1, TArg2, TArg3 >::FuncPtr >
    • XnEvent3Args< TArg1, TArg2, TArg3 >
  • XnEventInterfaceT< XnHandlerFunc4Args< TArg1, TArg2, TArg3, TArg4 >::FuncPtr >
    • XnEvent4Args< TArg1, TArg2, TArg3, TArg4 >
  • XnEventInterfaceT< XnHandlerFunc5Args< TArg1, TArg2, TArg3, TArg4, TArg5 >::FuncPtr >
    • XnEvent5Args< TArg1, TArg2, TArg3, TArg4, TArg5 >
  • XnEventInterfaceT< XnHandlerFuncNoArgs::FuncPtr >
    • XnEventNoArgs
  • XnFieldOfView
  • XnGeneralBuffer
  • XnHandlerFunc1Arg< TArg1 >
  • XnHandlerFunc2Args< TArg1, TArg2 >
  • XnHandlerFunc3Args< TArg1, TArg2, TArg3 >
  • XnHandlerFunc4Args< TArg1, TArg2, TArg3, TArg4 >
  • XnHandlerFunc5Args< TArg1, TArg2, TArg3, TArg4, TArg5 >
  • XnHandlerFuncNoArgs
  • XnHash
  • XnHashT< TKey, TValue, TKeyManager, TAlloc >
  • XnHashT< const XnChar *, TValue, XnStringsHashKeyManager, XnStringsNodeAllocator< TValue > >
    • XnStringsHashT< TValue >
  • XnHashT< const XnChar *, void *, XnStringsHashKeyManager, XnStringsNodeAllocator< void * > >
    • XnStringsHashT< void * >
      • XnStringsSet
  • XnImageMetaData
  • XnIRMetaData
  • XnKeyValuePair< _TKey, _TValue >
  • XnLicense
  • XnLinkedNodeDefaultAllocatorT< T >
  • XnLinkedNodeT< T >
  • XnLinkedNodeT< TCallback * >
  • XnLinkedNodeT< TPair >
  • XnList
  • XnListT< T, TAlloc >
    • XnQueueT< T, TAlloc >
      • XnCyclicQueueT< T, TDefaultMaxDepth, TAlloc >
    • XnStackT< T, TAlloc >
      • XnCyclicStackT< T, TDefaultMaxDepth, TAlloc >
  • XnListT< TCallback * >
  • XnListT< TPair, XnStringsNodeAllocator< TValue > >
  • XnListT< TPair, XnStringsNodeAllocator< void * > >
  • XnLogEntry
  • XnLogger
  • XnLogWriter
  • XnLogWriterBase
  • XnMapMetaData
  • XnMapOutputMode
  • XnMatrix3X3
  • XnModuleAlternativeViewPointInterface
  • XnModuleAntiFlickerInterface
  • XnModuleAudioGeneratorInterface
  • XnModuleCodecInterface
  • XnModuleCroppingInterface
  • XnModuleDepthGeneratorInterface
  • XnModuleDeviceIdentificationInterface
  • XnModuleDeviceInterface
  • XnModuleErrorStateInterface
  • XnModuleExportedProductionNodeInterface
  • XnModuleExtendedSerializationInterface
  • XnModuleFrameSyncInterface
  • XnModuleGeneralIntInterface
  • XnModuleGeneratorInterface
  • XnModuleGestureGeneratorInterface
  • XnModuleHandsGeneratorInterface
  • XnModuleHandTouchingFOVEdgeCapabilityInterface
  • XnModuleImageGeneratorInterface
  • XnModuleIRGeneratorInterface
  • XnModuleLockAwareInterface
  • XnModuleMapGeneratorInterface
  • XnModuleMirrorInterface
  • XnModulePlayerInterface
  • XnModulePoseDetectionCapabilityInterface
  • XnModuleProductionNodeInterface
  • XnModuleRecorderInterface
  • XnModuleSceneAnalyzerInterface
  • XnModuleScriptNodeInterface
  • XnModuleSkeletonCapabilityInterface
  • XnModuleUserGeneratorInterface
  • XnModuleUserPositionCapabilityInterface
  • XnNodeInfoListIterator
  • XnNodeNotifications
  • XnOpenNIModuleInterface
  • XnOSEvent
  • xnOSInfo
  • XnOutputMetaData
  • XnPlane3D
  • XnPlayerInputStreamInterface
  • XnProductionNodeDescription
  • XnQueue
    • XnThreadSafeQueue
  • XnRecorderOutputStreamInterface
  • XnRGB24Pixel
  • XnSceneMetaData
  • XnSkeletonJointOrientation
  • XnSkeletonJointPosition
  • XnSkeletonJointTransformation
  • XnStack
  • XnStringsHashKeyManager
  • XnStringsKeyManager
  • XnStringsKeyTranslator
  • XnStringsNodeAllocator< TValue >
  • XnSupportedPixelFormats
  • XnUInt32XYPair
  • XnUSBConfigDescriptorHolder
  • XnUSBDeviceDescriptorHolder
  • XnUSBEventArgs
  • XnUSBInterfaceDescriptorHolder
  • XnUSBStringDescriptor
  • XnVector3D
  • XnVersion
  • XnWaveOutputMode
  • XnYUV422DoublePixel
• Class Members
• Namespace List
  • xn
• Namespace Members
• File List
  • IXnNodeAllocator.h
  • XnAlgorithms.h
  • XnArray.h
  • XnBaseNode.h
  • XnBitSet.h
  • XnCallback.h
  • XnCodecIDs.h
  • XnContext.h
  • XnCppWrapper.h
  • XnCyclicQueueT.h
  • XnCyclicStackT.h
  • XnDataTypes.h
  • XnDerivedCast.h
  • XnDump.h
  • XnDumpWriters.h
  • XnEnumerationErrors.h
  • XnEvent.h
  • XnEventT.h
  • XnFPSCalculator.h
  • XnGeneralBuffer.h
  • XnHash.h
  • XnHashT.h
  • XnInternalDefs.h
  • XnLicensing.h
  • XnList.h
  • XnListT.h
  • XnLog.h
  • XnLogTypes.h
  • XnLogWriterBase.h
  • XnMacros.h
  • XnModuleCFunctions.h
  • XnModuleCppInterface.h
  • XnModuleCppRegistratration.h
  • XnModuleInterface.h
  • XnNode.h
  • XnNodeAllocator.h
  • XnOpenNI.h
  • XnOS.h
  • XnOSCpp.h
  • XnOSMemory.h
  • XnOSStrings.h
  • XnPlatform.h
  • XnPrdNode.h
  • XnPrdNodeInfo.h
  • XnPrdNodeInfoList.h
  • XnProfiling.h
  • XnPropNames.h
  • XnQueries.h
  • XnQueue.h
  • XnQueueT.h
  • XnScheduler.h
  • XnStack.h
  • XnStackT.h
  • XnStatus.h
  • XnStatusCodes.h
  • XnStatusRegister.h
  • XnStringsHash.h
  • XnStringsHashT.h
  • XnThreadSafeQueue.h
  • XnTypes.h
  • XnUSB.h
  • XnUSBDevice.h
  • XnUtils.h
  • XnVersion.h
• File Members

next page

Get in touch

Submit feedback about this site to:

• [email protected]