Share via

KinectRegion Members

Kinect for Windows 1.7, 1.8

The following table(s) list the members exposed by the KinectRegion type.

Public Constructors

Name Description
Public Method KinectRegion Creates a new KinectRegion object.

Public Properties

Name Description
Public Property CursorExtendedColor1 Gets or sets the primary cursor extended color.
Public Property CursorExtendedColor2 Gets or sets the secondary cursor extended color.
Public Property CursorGrippedColor1 Gets or sets the primary color to use when the cursor is in a grippped state.
Public Property CursorGrippedColor2 The secondary color to use when the cursor is in a gripped state.
Public Property CursorPressingColor Gets or sets the color to use when the cursor is in a pressing state.
Public Property HandPointers Gets the hand pointers.
Public Property IsCursorVisible Gets or sets the cursor visibility status.
Public Property Static IsGripTarget Gets or sets the grip target status.
Public Property Static IsPressTarget Gets or sets the press target status of the region.
Public Property Static IsPrimaryHandPointerOver Gets or sets whether the primary hand pointer is over the region.
Public Property Static KinectRegion Gets or sets the KinectRegion.
Public Property KinectSensor Gets or sets the Kinect Sensor associated with this KinectRegion.
Public Property Static PressTargetPoint Gets or sets the press target coordinates. The coordinate space for a control ranges from (0.0, 0.0) to (1.0, 1.0). Therefore, this property should not be set to coordinates outside this range.
Public Property PrimaryUserTrackingId Gets the tracking ID of the primary user.
Public Property QueryPrimaryUserTrackingIdCallback Gets or sets the callback when issuing a QueryPrimaryUserTrackingID call.

Public Methods

Name Description
Public Method Static AddHandPointerEnterHandler Adds a hand pointer enter event handler.
Public Method Static AddHandPointerGotCaptureHandler Adds a handler for a hand pointer got capture event.
Public Method Static AddHandPointerGripHandler Adds a handler for the hand pointer grip event.
Public Method Static AddHandPointerGripReleaseHandler Adds an event handler for a hand pointer grip release event.
Public Method Static AddHandPointerLeaveHandler Adds a handler for a hand pointer leave event.
Public Method Static AddHandPointerLostCaptureHandler Adds event for a hand pointer lost capture event.
Public Method Static AddHandPointerMoveHandler Adds a handler for a hand pointer move event.
Public Method Static AddHandPointerPressHandler Adds a handler for the hand pointer press event.
Public Method Static AddHandPointerPressReleaseHandler Adds a handler for the hand press release event.
Public Method Static AddQueryInteractionStatusHandler Adds a handler for the query interaction status event.
Public Method Static GetIsGripTarget Returns whether a given control is the grip target.
Public Method Static GetIsPressTarget Returns whether the control is a press target.
Public Method Static GetIsPrimaryHandPointerOver Returns whether the primary hand pointer is over the control.
Public Method Static GetKinectRegion Returns the KinectRegion associated with the given control.
Public Method Static GetPressTargetPoint Returns the (x,y) coordinates of the final press ___location of the control.
Public Method OnApplyTemplate Method used when a template is applied.
Public Method Static RemoveHandPointerEnterHandler Removes a hand pointer enter event handler.
Public Method Static RemoveHandPointerGotCaptureHandler Removes a hand pointer got capture event handler.
Public Method Static RemoveHandPointerGripHandler Removes a handler for a hand pointer grip event.
Public Method Static RemoveHandPointerGripReleaseHandler Removes a hand pointer grip release handler.
Public Method Static RemoveHandPointerLeaveHandler Removes a hand pointer leave event handler.
Public Method Static RemoveHandPointerLostCaptureHandler Removes a hand pointer lost capture handler.
Public Method Static RemoveHandPointerMoveHandler Removes a hand pointer move event handler.
Public Method Static RemoveHandPointerPressHandler Removes a hand pointer press event handler.
Public Method Static RemoveHandPointerPressReleaseHandler Removes a hand pointer press release event handler.
Public Method Static RemoveQueryInteractionStatusHandler Removes a query interaction status event handler.
Public Method Static SetIsGripTarget Sets whether a given control is a grip target.
Public Method Static SetIsPressTarget Sets whether a given control is a press target.
Public Method Static SetIsPrimaryHandPointerOver Sets whether the primary hand pointer is over the region.
Public Method Static SetKinectRegion Sets the KinectRegion for a given control.
Public Method Static SetPressTargetPoint Sets the press target point for a given control.

Public Events

Name Description
Public Event Static HandPointerEnter Event fired when a hand pointer enters the KinectRegion.
Public Event Static HandPointerGotCapture Event fired when a hand pointer is considered "captured" by a control. Captured means that the KinectInteraction software is confident that a user intends to interact with that control.
Public Event Static HandPointerGrip Event fired when the hand pointer is gripping.
Public Event Static HandPointerGripRelease Event fired when a gripping hand releases its grip.
Public Event Static HandPointerLeave Event fired when the hand pointer leaves the KinectRegion.
Public Event Static HandPointerLostCapture Event fired when the hand pointer capture is lost (the software no longer believes that the user intends to interact with this region).
Public Event Static HandPointerMove Event fired when the hand pointer is moving.
Public Event Static HandPointerPress Event fired when the user is pressing in the KinectRegion.
Public Event Static HandPointerPressRelease Event fired when a user is releasing a press in the given region.
Public Event HandPointersUpdated Event fired when the hand pointer is updated.
Public Event PrimaryUserTrackingIdChanged Event fired when the tracking ID for the primary user has changed.
Public Event Static QueryInteractionStatus Event fired when the interaction status is queried.

See Also

Reference

KinectRegion Class
Microsoft.Kinect.Toolkit.Controls Namespace