unreal.GoogleVRPointerInputComponent
¶
-
class
unreal.
GoogleVRPointerInputComponent
(outer=None, name='None')¶ Bases:
unreal.ActorComponent
GoogleVRPointerInputComponent is used to interact with Actors and Widgets by using a 3D pointer. The pointer can be a cardboard reticle, or a daydream controller.
See: UGoogleVRMotionControllerComponent See: UGoogleVRGazeReticleComponent
C++ Source:
Plugin: GoogleVRController
Module: GoogleVRController
File: GoogleVRPointerInputComponent.h
Editor Properties: (see get_editor_property/set_editor_property)
asset_user_data
(Array(AssetUserData)): [Read-Write] Array of user data stored with the componentauto_activate
(bool): [Read-Write] Whether the component is activated at creation or must be explicitly activated.can_ever_affect_navigation
(bool): [Read-Write] Whether this component can potentially influence navigationcomponent_tags
(Array(Name)): [Read-Write] Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.editable_when_inherited
(bool): [Read-Write] True if this component can be modified when it was inherited from a parent actor classfar_clipping_distance
(float): [Read-Write] The maximum distance an object can be from the start of the pointer for the pointer to hit it.is_editor_only
(bool): [Read-Write] If true, the component will be excluded from non-editor buildsnear_clipping_distance
(float): [Read-Write] The minimum distance an object needs to be from the camera for the pointer to hit it. Note: Only used when PointerInputMode is set to Camera.on_component_activated
(ActorComponentActivatedSignature): [Read-Write] Called when the component has been activated, with parameter indicating if it was from a reseton_component_deactivated
(ActorComponentDeactivateSignature): [Read-Write] Called when the component has been deactivatedon_pointer_click_actor_event
(GoogleVRInputDelegate): [Read-Write] Event that occurs once when the pointer is clicked. A click is when the pointer is pressed and then released while pointing at the same actor.on_pointer_click_component_event
(GoogleVRInputDelegate): [Read-Write] Event that occurs once when the pointer is clicked. A click is when the pointer is pressed and then released while pointing at the same component.on_pointer_enter_actor_event
(GoogleVRInputDelegate): [Read-Write] Event that occurs when the pointer enters an actor.on_pointer_enter_component_event
(GoogleVRInputDelegate): [Read-Write] Event that occurs when the pointer enters a component.on_pointer_exit_actor_event
(GoogleVRInputExitActorDelegate): [Read-Write] Event that occurs when the pointer exits an actor.on_pointer_exit_component_event
(GoogleVRInputExitComponentDelegate): [Read-Write] Event that occurs when the pointer exits a component.on_pointer_hover_actor_event
(GoogleVRInputDelegate): [Read-Write] Event that occurs once when the pointer is hovering over an actor.on_pointer_hover_component_event
(GoogleVRInputDelegate): [Read-Write] Event that occurs once when the pointer is hovering over a component.on_pointer_pressed_event
(GoogleVRInputDelegate): [Read-Write] Event that occurs once when the pointer initiates a click.on_pointer_released_event
(GoogleVRInputDelegate): [Read-Write] Event that occurs once when the pointer ends a click.primary_component_tick
(ActorComponentTickFunction): [Read-Write] Main tick function for the Componentreplicates
(bool): [Read-Write] Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!use_controller_click
(bool): [Read-Write] Determines if pointer clicks will occur from controller clicks.use_touch_click
(bool): [Read-Write] Determines if pointer clicks will occur from touching the screen.widget_interaction
(GoogleVRWidgetInteractionComponent): [Read-Write] WidgetInteractionComponent used to integrate pointer input with UMG widgets.
-
property
far_clipping_distance
¶ [Read-Write] The maximum distance an object can be from the start of the pointer for the pointer to hit it.
- Type
(float)
-
get_hit_component
() → PrimitiveComponent¶ The component that the actor being pointed at.
- Returns
- Return type
-
get_intersection_location
() → Vector¶ The world location where the pointer intersected with the hit actor.
- Returns
- Return type
-
get_latest_hit_result
() → HitResult¶ Get the result of the latest hit detection.
- Returns
- Return type
-
get_pointer
() → GoogleVRPointer¶ Get the Pointer being used for this input component.
- Returns
- Return type
GoogleVRPointer
-
property
near_clipping_distance
¶ [Read-Write] The minimum distance an object needs to be from the camera for the pointer to hit it. Note: Only used when PointerInputMode is set to Camera.
- Type
(float)
-
property
on_pointer_click_actor_event
¶ [Read-Write] Event that occurs once when the pointer is clicked. A click is when the pointer is pressed and then released while pointing at the same actor.
- Type
-
property
on_pointer_click_component_event
¶ [Read-Write] Event that occurs once when the pointer is clicked. A click is when the pointer is pressed and then released while pointing at the same component.
- Type
-
property
on_pointer_enter_actor_event
¶ [Read-Write] Event that occurs when the pointer enters an actor.
- Type
-
property
on_pointer_enter_component_event
¶ [Read-Write] Event that occurs when the pointer enters a component.
- Type
-
property
on_pointer_exit_actor_event
¶ [Read-Write] Event that occurs when the pointer exits an actor.
-
property
on_pointer_exit_component_event
¶ [Read-Write] Event that occurs when the pointer exits a component.
-
property
on_pointer_hover_actor_event
¶ [Read-Write] Event that occurs once when the pointer is hovering over an actor.
- Type
-
property
on_pointer_hover_component_event
¶ [Read-Write] Event that occurs once when the pointer is hovering over a component.
- Type
-
property
on_pointer_pressed_event
¶ [Read-Write] Event that occurs once when the pointer initiates a click.
- Type
-
property
on_pointer_released_event
¶ [Read-Write] Event that occurs once when the pointer ends a click.
- Type
-
set_pointer
(new_pointer) → None¶ Set the Pointer to use for this input component.
- Parameters
new_pointer (GoogleVRPointer) –
-
property
use_controller_click
¶ [Read-Write] Determines if pointer clicks will occur from controller clicks.
- Type
(bool)
-
property
use_touch_click
¶ [Read-Write] Determines if pointer clicks will occur from touching the screen.
- Type
(bool)
-
property
widget_interaction
¶ [Read-Write] WidgetInteractionComponent used to integrate pointer input with UMG widgets.