unreal.ARTrackableNotifyComponent

class unreal.ARTrackableNotifyComponent(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: ActorComponent

Component used to listen to ar trackable object changes

C++ Source:

  • Module: AugmentedReality

  • File: ARTrackableNotifyComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

  • asset_user_data (Array[AssetUserData]): [Read-Write] Asset User Data: Array of user data stored with the component

  • auto_activate (bool): [Read-Write] Auto Activate: Whether the component is activated at creation or must be explicitly activated.

  • can_ever_affect_navigation (bool): [Read-Write] Can Ever Affect Navigation: Whether this component can potentially influence navigation

  • component_tags (Array[Name]): [Read-Write] Component Tags: Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.

  • editable_when_inherited (bool): [Read-Write] Editable when Inherited: True if this component can be modified when it was inherited from a parent actor class

  • is_editor_only (bool): [Read-Write] Is Editor Only: If true, the component will be excluded from non-editor builds

  • on_add_tracked_env_probe (TrackableEnvProbeDelegate): [Read-Write] On Add Tracked Env Probe: Event that happens when any new ar environment capture probe item is added

  • on_add_tracked_face (TrackableFaceDelegate): [Read-Write] On Add Tracked Face: Event that happens when any new ar Face item is added

  • on_add_tracked_geometry (TrackableDelegate): [Read-Write] On Add Tracked Geometry: Event that happens when any new trackable ar item is added

  • on_add_tracked_image (TrackableImageDelegate): [Read-Write] On Add Tracked Image: Event that happens when any new ar Image item is added

  • on_add_tracked_object (TrackableObjectDelegate): [Read-Write] On Add Tracked Object: Event that happens when any new ar detected object item is added

  • on_add_tracked_plane (TrackablePlaneDelegate): [Read-Write] On Add Tracked Plane: Event that happens when any new ar plane item is added

  • on_add_tracked_point (TrackablePointDelegate): [Read-Write] On Add Tracked Point: Event that happens when any new ar Point item is added

  • on_component_activated (ActorComponentActivatedSignature): [Read-Write] On Component Activated: Called when the component has been activated, with parameter indicating if it was from a reset

  • on_component_deactivated (ActorComponentDeactivateSignature): [Read-Write] On Component Deactivated: Called when the component has been deactivated

  • on_remove_tracked_env_probe (TrackableEnvProbeDelegate): [Read-Write] On Remove Tracked Env Probe: Event that happens when any ar environment capture probe item is removed from the scene

  • on_remove_tracked_face (TrackableFaceDelegate): [Read-Write] On Remove Tracked Face: Event that happens when any ar Face item is removed from the scene

  • on_remove_tracked_geometry (TrackableDelegate): [Read-Write] On Remove Tracked Geometry: Event that happens when any trackable ar item is removed from the scene

  • on_remove_tracked_image (TrackableImageDelegate): [Read-Write] On Remove Tracked Image: Event that happens when any ar Image item is removed from the scene

  • on_remove_tracked_object (TrackableObjectDelegate): [Read-Write] On Remove Tracked Object: Event that happens when any ar detected object item is removed from the scene

  • on_remove_tracked_plane (TrackablePlaneDelegate): [Read-Write] On Remove Tracked Plane: Event that happens when any ar plane item is removed from the scene

  • on_remove_tracked_point (TrackablePointDelegate): [Read-Write] On Remove Tracked Point: Event that happens when any ar Point item is removed from the scene

  • on_update_tracked_env_probe (TrackableEnvProbeDelegate): [Read-Write] On Update Tracked Env Probe: Event that happens when any ar environment capture probe item is updated

  • on_update_tracked_face (TrackableFaceDelegate): [Read-Write] On Update Tracked Face: Event that happens when any ar Face item is updated

  • on_update_tracked_geometry (TrackableDelegate): [Read-Write] On Update Tracked Geometry: Event that happens when any trackable ar item is updated

  • on_update_tracked_image (TrackableImageDelegate): [Read-Write] On Update Tracked Image: Event that happens when any ar Image item is updated

  • on_update_tracked_object (TrackableObjectDelegate): [Read-Write] On Update Tracked Object: Event that happens when any ar detected object item is updated

  • on_update_tracked_plane (TrackablePlaneDelegate): [Read-Write] On Update Tracked Plane: Event that happens when any ar plane item is updated

  • on_update_tracked_point (TrackablePointDelegate): [Read-Write] On Update Tracked Point: Event that happens when any ar Point item is updated

  • primary_component_tick (ActorComponentTickFunction): [Read-Write] Primary Component Tick: Main tick function for the Component

  • replicate_using_registered_sub_object_list (bool): [Read-Write] Replicate Using Registered Sub Object List: When true the replication system will only replicate the registered subobjects list When false the replication system will instead call the virtual ReplicateSubObjects() function where the subobjects need to be manually replicated.

  • replicates (bool): [Read-Write] Replicates: Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!

property on_add_tracked_env_probe: TrackableEnvProbeDelegate

[Read-Write] On Add Tracked Env Probe: Event that happens when any new ar environment capture probe item is added

Type:

(TrackableEnvProbeDelegate)

property on_add_tracked_face: TrackableFaceDelegate

[Read-Write] On Add Tracked Face: Event that happens when any new ar Face item is added

Type:

(TrackableFaceDelegate)

property on_add_tracked_geometry: TrackableDelegate

[Read-Write] On Add Tracked Geometry: Event that happens when any new trackable ar item is added

Type:

(TrackableDelegate)

property on_add_tracked_image: TrackableImageDelegate

[Read-Write] On Add Tracked Image: Event that happens when any new ar Image item is added

Type:

(TrackableImageDelegate)

property on_add_tracked_object: TrackableObjectDelegate

[Read-Write] On Add Tracked Object: Event that happens when any new ar detected object item is added

Type:

(TrackableObjectDelegate)

property on_add_tracked_plane: TrackablePlaneDelegate

[Read-Write] On Add Tracked Plane: Event that happens when any new ar plane item is added

Type:

(TrackablePlaneDelegate)

property on_add_tracked_point: TrackablePointDelegate

[Read-Write] On Add Tracked Point: Event that happens when any new ar Point item is added

Type:

(TrackablePointDelegate)

property on_remove_tracked_env_probe: TrackableEnvProbeDelegate

[Read-Write] On Remove Tracked Env Probe: Event that happens when any ar environment capture probe item is removed from the scene

Type:

(TrackableEnvProbeDelegate)

property on_remove_tracked_face: TrackableFaceDelegate

[Read-Write] On Remove Tracked Face: Event that happens when any ar Face item is removed from the scene

Type:

(TrackableFaceDelegate)

property on_remove_tracked_geometry: TrackableDelegate

[Read-Write] On Remove Tracked Geometry: Event that happens when any trackable ar item is removed from the scene

Type:

(TrackableDelegate)

property on_remove_tracked_image: TrackableImageDelegate

[Read-Write] On Remove Tracked Image: Event that happens when any ar Image item is removed from the scene

Type:

(TrackableImageDelegate)

property on_remove_tracked_object: TrackableObjectDelegate

[Read-Write] On Remove Tracked Object: Event that happens when any ar detected object item is removed from the scene

Type:

(TrackableObjectDelegate)

property on_remove_tracked_plane: TrackablePlaneDelegate

[Read-Write] On Remove Tracked Plane: Event that happens when any ar plane item is removed from the scene

Type:

(TrackablePlaneDelegate)

property on_remove_tracked_point: TrackablePointDelegate

[Read-Write] On Remove Tracked Point: Event that happens when any ar Point item is removed from the scene

Type:

(TrackablePointDelegate)

property on_update_tracked_env_probe: TrackableEnvProbeDelegate

[Read-Write] On Update Tracked Env Probe: Event that happens when any ar environment capture probe item is updated

Type:

(TrackableEnvProbeDelegate)

property on_update_tracked_face: TrackableFaceDelegate

[Read-Write] On Update Tracked Face: Event that happens when any ar Face item is updated

Type:

(TrackableFaceDelegate)

property on_update_tracked_geometry: TrackableDelegate

[Read-Write] On Update Tracked Geometry: Event that happens when any trackable ar item is updated

Type:

(TrackableDelegate)

property on_update_tracked_image: TrackableImageDelegate

[Read-Write] On Update Tracked Image: Event that happens when any ar Image item is updated

Type:

(TrackableImageDelegate)

property on_update_tracked_object: TrackableObjectDelegate

[Read-Write] On Update Tracked Object: Event that happens when any ar detected object item is updated

Type:

(TrackableObjectDelegate)

property on_update_tracked_plane: TrackablePlaneDelegate

[Read-Write] On Update Tracked Plane: Event that happens when any ar plane item is updated

Type:

(TrackablePlaneDelegate)

property on_update_tracked_point: TrackablePointDelegate

[Read-Write] On Update Tracked Point: Event that happens when any ar Point item is updated

Type:

(TrackablePointDelegate)