unreal.MagicLeapCVCameraComponent

class unreal.MagicLeapCVCameraComponent(outer=None, name='None')

Bases: unreal.ActorComponent

The MagicLeapCVCameraComponent provides access to and maintains state for computer vision camera capture functionality. The connection to the device’s camera is managed internally. Users of this component are able to retrieve various computer vision data for processing.

C++ Source:

  • Plugin: MagicLeapCamera

  • Module: MagicLeapCVCamera

  • File: MagicLeapCVCameraComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

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

  • auto_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 navigation

  • component_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 class

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

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

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

  • on_disabled (MagicLeapCVCameraDisableMulti): [Read-Write] On Disabled

  • on_log_message (MagicLeapCameraLogMessageMulti): [Read-Write] On Log Message

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

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

get_camera_output() → MagicLeapCameraOutput or None

Gets the latest transform of the camera.

Returns

True if the transform was successfully retrieved, false otherwise.

out_camera_output (MagicLeapCameraOutput):

Return type

MagicLeapCameraOutput or None

get_frame_pose() → Transform or None

Gets the latest transform of the camera.

Returns

True if the transform was successfully retrieved, false otherwise.

out_frame_pose (Transform): Contains the returned transform of the camera if the call is successful.

Return type

Transform or None

get_intrinsic_calibration_parameters() → MagicLeapCVCameraIntrinsicCalibrationParameters or None

Gets the intrinsic calibration parameters of the camera. Requires the camera to be connected.

Returns

True if the parameters were successfully retrieved, false otherwise.

out_params (MagicLeapCVCameraIntrinsicCalibrationParameters):

Return type

MagicLeapCVCameraIntrinsicCalibrationParameters or None

property on_disabled

[Read-Write] On Disabled

Type

(MagicLeapCVCameraDisableMulti)

property on_log_message

[Read-Write] On Log Message

Type

(MagicLeapCameraLogMessageMulti)