General-Purpose Components
Here you can find the short descriptions of the general-purpose components. For detailed description of each component and its properties, select the component on the left (this will be added later). Please note, all Kinect-related components need the KinectManager-component in the scene. The KinectManager should persist across all scenes. To avoid having multiple KinectManager instances in the scene, see 'Howto-Use-KinectManager-Across-Multiple-Scenes.pdf'-manual in the _Readme-folder of the K4A-asset.
Component: |
Description: |
AvatarController |
Avatar controller is the component that transfers the captured user motion to a humanoid model (avatar). |
AvatarControllerClassic |
Avatar controller classic allows manual assignment of model's rigged bones to the tracked body joints. |
AvatarScaler |
Avatar scaler is the component that scales avatar's body, according to the user's body and bone sizes. |
BackgroundColorCamDepthImage |
BackgroundColorCamDepthImage is component that displays the color camera aligned depth image on RawImage texture, usually the scene background. |
BackgroundColorCamInfraredImage |
BackgroundColorCamInfraredImage is component that displays the color camera aligned infrared image on RawImage texture, usually the scene background. |
BackgroundColorCamUserImage |
BackgroundColorCamUserImage is component that displays the color camera aligned user-body image on RawImage texture, usually the scene background. |
BackgroundColorImage |
Background color image is component that displays the color camera feed on RawImage texture, usually the scene background. |
BackgroundDepthCamColorImage |
Background depth-cam color image is component that displays the depth camera aligned color image on RawImage texture, usually the scene background. |
BackgroundDepthImage |
Background depth image is component that displays the depth camera image on RawImage texture, usually the scene background. |
BackgroundInfraredImage |
Background infrared image is component that displays the infrared camera image on RawImage texture, usually the scene background. |
BackgroundRemovalByBodyBounds |
BackgroundRemovalByBodyBounds filters user silhouettes, according to the bounds determined by the positions of the body joints. |
BackgroundRemovalByBodyIndex |
BackgroundRemovalByBodyIndex filters user silhouettes, according to the body index frames coming from the body tracking SDK. |
BackgroundRemovalByDist |
BackgroundRemovalByDist filters part of the real environment, according to the given spatial limits. |
BackgroundRemovalByGreenScreen |
BackgroundRemovalByGreenScreen filters color camera data, according to its similarity or difference to the color of the green-screen. |
BackgroundRemovalManager |
Background removal manager is the component that filters and renders user body silhouettes. |
BackgroundStaticImage |
Background static image is component that displays the static image on RawImage texture, usually the scene background. |
BackgroundUserBodyImage |
Background user-body image is component that displays the user-body image on RawImage texture, usually the scene background. |
BodyDataRecorderPlayer |
BodyDataRecorderPlayer is the component that can be used for recording and replaying of body-data files. |
BodySlicer |
Body slicer is component that estimates the user height from the raw depth data, as well as several other body sizes. |
CubemanController |
Cubeman controller transfers the captured user motion to a cubeman model. |
DepthIrFilterImage |
DepthIrFilterImage filters the sensor's IR image with the raw depth. The resulting image is displayed on the given RawImage. |
FollowSensorTransform |
Follow sensor transform makes the game object follow the position and rotation of the sensor. |
FollowUserJointPose |
FollowUserJointPose makes the game object's transform follow the given user's joint pose. |
ForegroundBlendRenderer |
ForegroundBlendRenderer provides volumetric rendering and lighting of the real environment, filtered by the background-removal manager. |
ForegroundToRawImage |
ForegroundToRawImage sets the texture of the RawImage-component to be the BRM's foreground texture. |
ForegroundToRenderer |
ForegroundToRenderer sets the texture of the Renderer-component to be the BRM's foreground texture. |
HmdHeadMover |
HmdHeadMover moves the avatar model, according to the camera position reported by the HMD tracker. |
InteractionInputModule |
InteractionInputModule is the input module that can be used as component of the Unity-UI EventSystem. |
InteractionManager |
InteractionManager is the component that controls the hand cursor and manages the hand interactions. |
KinectEventManager |
KinectEventManager provides sensor-frame events to the registered Unity event listeners. |
KinectGestureManager |
Kinect gesture manager is the component that tracks and processes the user gestures. |
KinectManager |
KinectManager is the the main and most basic depth-sensor related component. It controls the sensors and manages the data streams. |
KinectNetServer |
Kinect net-server listens for client connections and sends the data from the given sensor's streams to its clients over the network. |
KinectUserBodyMerger |
KinectUserBodyMerger merges user bodies detected by multiple connected sensors. |
KinectUserManager |
Kinect user manager is the component that tracks the users in front of the sensor. |
MultiCameraSyncher |
MultiCameraSyncher enables synchronization of frames between the master and the subordinate sensors. |
PhotoShooter |
Photo shooter provides public functions to take pictures of the currently rendered scene. |
PointCloudTarget |
PointCloudTarget sets the point cloud resolution of the respective sensor, as well as the target render textures. |
PortraitBackground |
Portrait background is the component that sets the background image in the required screen resolution. |
PoseModelHelper |
Pose model helper matches the sensor-tracked joints to model transforms. |
PoseModelHelperClassic |
Pose model helper matches the sensor-tracked joints to model transforms (with manual assignment). |
SceneBlendRenderer |
SceneBlendRenderer provides volumetric rendering and lighting of the real environment, as seen by the sensor's color camera. |
SceneMeshRenderer |
SceneMeshRenderer renders virtual mesh of the environment in the scene, as detected by the given sensor. |
SceneMeshRendererGpu |
SceneMeshRendererGpu renders virtual mesh of the environment in the scene, as detected by the given sensor. This component uses GPU for mesh processing rather than CPU. |
UserMeshRenderer |
UserMeshRenderer renders virtual mesh of a user in the scene, as detected by the given sensor. |
UserMeshRendererGpu |
UserMeshRendererGpu renders virtual mesh of a user in the scene, as detected by the given sensor. This component uses GPU for mesh processing rather than CPU. |
UserSkeletonCollider |
UserSkeletonCollider creates colliders for the joints and bones of the given user, so they can interact with the physical objects in the scene. |