unreal.GoogleARCoreSessionConfig
¶
- class unreal.GoogleARCoreSessionConfig(outer: Optional[Object] = None, name: Union[Name, str] = 'None')¶
Bases:
ARSessionConfig
A UDataAsset that can be used to configure ARCore specific settings on top of UARSessionConfig.
C++ Source:
Plugin: GoogleARCore
Module: GoogleARCoreBase
File: GoogleARCoreSessionConfig.h
Editor Properties: (see get_editor_property/set_editor_property)
augmented_face_mode
(GoogleARCoreAugmentedFaceMode): [Read-Write] Augmented Face Mode: Configure which Augmented Face mode will be used in the AR session.augmented_image_database
(GoogleARCoreAugmentedImageDatabase): [Read-Write] Augmented Image Database: A UGoogleARCoreAugmentedImageDatabase asset to use use for image tracking.camera_facing
(GoogleARCoreCameraFacing): [Read-Write] Camera Facing: Configure which camera will be used to in the AR session.candidate_images
(Array[ARCandidateImage]): [Read-Write] Candidate Images: The list of candidate images to detect within the AR camera view. This feature is used by ARKit.candidate_objects
(Array[ARCandidateObject]): [Read-Write] Candidate Objects: The list of candidate objects to search for in the scene. This feature is used by ARKit.default_mesh_material
(MaterialInterface): [Read-Write] Default Mesh Material: The default mesh material used by the generated mesh component.default_wireframe_mesh_material
(MaterialInterface): [Read-Write] Default Wireframe Mesh Material: The default mesh material used by the wireframe setting of the generated mesh component. Note: It is recommended to ignore this wireframe feature and use a wireframe material for the DefaultMeshMaterial instead.desired_video_format
(ARVideoFormat): [Read-Write] Desired Video Format: The desired video format (or the default, if not supported) that this session should use if the camera is enabled. Use GetSupportedVideoFormats to get a list of device-supported formats.enable_auto_focus
(bool): [Read-Write] Enable Auto Focus: Boolean to determine whether the camera should autofocus. Autofocus can cause subtle shifts in position for small objects at further camera distance. This feature is used by ARCore and ARKit.enable_automatic_camera_overlay
(bool): [Read-Write] Enable Automatic Camera Overlay: Boolean to determine whether the AR camera feed should be drawn as an overlay. Defaults to true. This feature is used by ARCore and ARKit.enable_automatic_camera_tracking
(bool): [Read-Write] Enable Automatic Camera Tracking: Boolean to determine whether the virtual camera should track the device movement. Defaults to true. This feature is used by ARCore and ARKit.enabled_session_tracking_feature
(ARSessionTrackingFeature): [Read-Write] Enabled Session Tracking Feature: see: EARSessionTrackingFeatureenvironment_capture_probe_type
(AREnvironmentCaptureProbeType): [Read-Write] Environment Capture Probe Type: see: EAREnvironmentCaptureProbeTypeenvironment_probe_component_class
(type(Class)): [Read-Write] Environment Probe Component Class: see: UAREnvironmentProbeComponentface_component_class
(type(Class)): [Read-Write] Face Component Class: see: UARFaceComponentface_tracking_direction
(ARFaceTrackingDirection): [Read-Write] Face Tracking Direction: see: EARFaceTrackingDirectionface_tracking_update
(ARFaceTrackingUpdate): [Read-Write] Face Tracking Update: see: EARFaceTrackingUpdateframe_sync_mode
(ARFrameSyncMode): [Read-Write] Frame Sync Mode: see: EARFrameSyncModegenerate_collision_for_mesh_data
(bool): [Read-Write] Generate Collision for Mesh Data: Boolean to determine whether the AR system should generate collision data from the mesh data.generate_mesh_data_from_tracked_geometry
(bool): [Read-Write] Generate Mesh Data from Tracked Geometry: Boolean to determine whether the AR system should generate mesh data that can be used for rendering, collision, NavMesh, and more. This feature is used by OpenXR, Windows Mixed Reality.generate_nav_mesh_for_mesh_data
(bool): [Read-Write] Generate Nav Mesh for Mesh Data: Boolean to determine whether the AR system should generate collision data from the mesh data.geo_anchor_component_class
(type(Class)): [Read-Write] Geo Anchor Component Class: see: UARGeoAnchorComponenthorizontal_plane_detection
(bool): [Read-Write] Horizontal Plane Detection: Boolean to determine whether flat, horizontal surfaces are detected. This feature is used by ARCore and ARKit.image_component_class
(type(Class)): [Read-Write] Image Component Class: see: UARImageComponentlight_estimation_mode
(ARLightEstimationMode): [Read-Write] Light Estimation Mode: see: EARLightEstimationModemax_num_simultaneous_images_tracked
(int32): [Read-Write] Max Num Simultaneous Images Tracked: The maximum number of images to track at the same time. Defaults to 1. This feature is used by ARKit.max_number_of_tracked_faces
(int32): [Read-Write] Max Number Of Tracked Faces: The maximum number of faces to track simultaneously. This feature is used by ARKit.mesh_component_class
(type(Class)): [Read-Write] Mesh Component Class: see: UARMeshComponentobject_component_class
(type(Class)): [Read-Write] Object Component Class: see: UARObjectComponentplane_component_class
(type(Class)): [Read-Write] Plane Component Class: see: UARPlaneComponentpoint_component_class
(type(Class)): [Read-Write] Point Component Class: see: UARPointComponentpose_component_class
(type(Class)): [Read-Write] Pose Component Class: see: UARPoseComponentqr_code_component_class
(type(Class)): [Read-Write] QRCode Component Class: see: UARQRCodeComponentrender_mesh_data_in_wireframe
(bool): [Read-Write] Render Mesh Data in Wireframe: Boolean to determine whether the AR system should render the mesh data as wireframe. It is reccomended to simply set the DefaultMeshMaterial to whatever is desired, including a wireframe material and ignore this setting (there is no good reason for this to exist as a special case).reset_camera_tracking
(bool): [Read-Write] Reset Camera Tracking: Boolean to determine whether the AR system should reset camera tracking, such as its origin and transforms, when a new AR session starts. Defaults to true. This feature is used by ARKit.reset_tracked_objects
(bool): [Read-Write] Reset Tracked Objects: Boolean to determine whether the AR system should remove any tracked objects when a new AR session starts. Defaults to true. This feature is used by ARKit.scene_reconstruction_method
(ARSceneReconstruction): [Read-Write] Scene Reconstruction Method: see: EARSceneReconstructionsession_type
(ARSessionType): [Read-Write] Session Type: see: EARSessionTypetrack_scene_objects
(bool): [Read-Write] Track Scene Objects: Boolean to determine whether the AR system should track scene objects: see: EARObjectClassification::SceneObject.use_automatic_image_scale_estimation
(bool): [Read-Write] Use Automatic Image Scale Estimation: Boolean to determine whether to automatically estimate and set the scale of a detected, or tracked, image. This feature is used by ARKit.use_mesh_data_for_occlusion
(bool): [Read-Write] Use Mesh Data for Occlusion: Boolean to determine whether the AR system should render the mesh data as occlusion meshes.use_optimal_video_format
(bool): [Read-Write] Use Optimal Video Format: Boolean to determine whether to automatically pick the video format that best matches the device screen sizeuse_person_segmentation_for_occlusion
(bool): [Read-Write] Use Person Segmentation for Occlusion: Boolean to determine whether to use the person segmentation results for occluding virtual content. This feature is used by ARKit.use_scene_depth_for_occlusion
(bool): [Read-Write] Use Scene Depth for Occlusion: Boolean to determine whether to use the scene depth information for occluding virtual content. This feature is used by ARCore and ARKit.use_standard_onboarding_ux
(bool): [Read-Write] Use Standard Onboarding UX: Boolean to determine whether to use the standard onboarding UX, if the system supports it. This feature is used by ARKit.vertical_plane_detection
(bool): [Read-Write] Vertical Plane Detection: Boolean to determine whether flat, vertical surfaces are detected. This feature is used by ARCore and ARKit.world_alignment
(ARWorldAlignment): [Read-Write] World Alignment: see: EARWorldAlignmentworld_map_data
(Array[uint8]): [Read-Only] World Map Data: A previously saved world that will be loaded when the session starts. This feature is used by ARKit.
- get_augmented_image_database() GoogleARCoreAugmentedImageDatabase ¶
Get the augmented image database being used.
- Return type:
- set_augmented_image_database(new_image_database) None ¶
Set the augmented image database to use.
- Parameters:
new_image_database (GoogleARCoreAugmentedImageDatabase) –