You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
224 lines
11 KiB
Python
224 lines
11 KiB
Python
"""
|
|
Copyright (c) Contributors to the Open 3D Engine Project.
|
|
For complete copyright and license terms please see the LICENSE at the root of this distribution.
|
|
|
|
SPDX-License-Identifier: Apache-2.0 OR MIT
|
|
"""
|
|
|
|
import os
|
|
import sys
|
|
|
|
import azlmbr.asset as asset
|
|
import azlmbr.bus as bus
|
|
import azlmbr.camera
|
|
import azlmbr.entity as entity
|
|
import azlmbr.legacy.general as general
|
|
import azlmbr.math as math
|
|
import azlmbr.paths
|
|
import azlmbr.editor as editor
|
|
|
|
sys.path.append(os.path.join(azlmbr.paths.devroot, "AutomatedTesting", "Gem", "PythonTests"))
|
|
|
|
import editor_python_test_tools.hydra_editor_utils as hydra
|
|
from editor_python_test_tools.editor_test_helper import EditorTestHelper
|
|
from Atom.atom_utils.screenshot_utils import ScreenshotHelper
|
|
|
|
SCREEN_WIDTH = 1280
|
|
SCREEN_HEIGHT = 720
|
|
DEGREE_RADIAN_FACTOR = 0.0174533
|
|
|
|
helper = EditorTestHelper(log_prefix="Test_Atom_BasicLevelSetup")
|
|
|
|
|
|
def run():
|
|
"""
|
|
1. View -> Layouts -> Restore Default Layout, sets the viewport to ratio 16:9 @ 1280 x 720
|
|
2. Runs console command r_DisplayInfo = 0
|
|
3. Deletes all entities currently present in the level.
|
|
4. Creates a "default_level" entity to hold all other entities, setting the translate values to x:0, y:0, z:0
|
|
5. Adds a Grid component to the "default_level" & updates its Grid Spacing to 1.0m
|
|
6. Adds a "global_skylight" entity to "default_level", attaching an HDRi Skybox w/ a Cubemap Texture.
|
|
7. Adds a Global Skylight (IBL) component w/ diffuse image and specular image to "global_skylight" entity.
|
|
8. Adds a "ground_plane" entity to "default_level", attaching a Mesh component & Material component.
|
|
9. Adds a "directional_light" entity to "default_level" & adds a Directional Light component.
|
|
10. Adds a "sphere" entity to "default_level" & adds a Mesh component with a Material component to it.
|
|
11. Adds a "camera" entity to "default_level" & adds a Camera component with 80 degree FOV and Transform values:
|
|
Translate - x:5.5m, y:-12.0m, z:9.0m
|
|
Rotate - x:-27.0, y:-12.0, z:25.0
|
|
12. Finally enters game mode, takes a screenshot, exits game mode, & saves the level.
|
|
:return: None
|
|
"""
|
|
def initial_viewport_setup(screen_width, screen_height):
|
|
general.set_viewport_size(screen_width, screen_height)
|
|
general.update_viewport()
|
|
helper.wait_for_condition(
|
|
function=lambda: helper.isclose(a=general.get_viewport_size().x, b=SCREEN_WIDTH, rel_tol=0.1)
|
|
and helper.isclose(a=general.get_viewport_size().y, b=SCREEN_HEIGHT, rel_tol=0.1),
|
|
timeout_in_seconds=4.0
|
|
)
|
|
result = helper.isclose(a=general.get_viewport_size().x, b=SCREEN_WIDTH, rel_tol=0.1) and helper.isclose(
|
|
a=general.get_viewport_size().y, b=SCREEN_HEIGHT, rel_tol=0.1)
|
|
general.log(general.get_viewport_size().x)
|
|
general.log(general.get_viewport_size().y)
|
|
general.log(general.get_viewport_size().z)
|
|
general.log(f"Viewport is set to the expected size: {result}")
|
|
general.run_console("r_DisplayInfo = 0")
|
|
|
|
def after_level_load():
|
|
"""Function to call after creating/opening a level to ensure it loads."""
|
|
# Give everything a second to initialize.
|
|
general.idle_enable(True)
|
|
general.idle_wait(1.0)
|
|
general.update_viewport()
|
|
general.idle_wait(0.5) # half a second is more than enough for updating the viewport.
|
|
|
|
# Close out problematic windows, FPS meters, and anti-aliasing.
|
|
if general.is_helpers_shown(): # Turn off the helper gizmos if visible
|
|
general.toggle_helpers()
|
|
general.idle_wait(1.0)
|
|
if general.is_pane_visible("Error Report"): # Close Error Report windows that block focus.
|
|
general.close_pane("Error Report")
|
|
if general.is_pane_visible("Error Log"): # Close Error Log windows that block focus.
|
|
general.close_pane("Error Log")
|
|
general.idle_wait(1.0)
|
|
general.run_console("r_displayInfo=0")
|
|
general.run_console("r_antialiasingmode=0")
|
|
general.idle_wait(1.0)
|
|
|
|
return True
|
|
|
|
# Wait for Editor idle loop before executing Python hydra scripts.
|
|
general.idle_enable(True)
|
|
|
|
# Open the auto_test level.
|
|
new_level_name = "auto_test" # Specified in class TestAllComponentsIndepthTests()
|
|
heightmap_resolution = 512
|
|
heightmap_meters_per_pixel = 1
|
|
terrain_texture_resolution = 412
|
|
use_terrain = False
|
|
|
|
# Return codes are ECreateLevelResult defined in CryEdit.h
|
|
return_code = general.create_level_no_prompt(
|
|
new_level_name, heightmap_resolution, heightmap_meters_per_pixel, terrain_texture_resolution, use_terrain)
|
|
if return_code == 1:
|
|
general.log(f"{new_level_name} level already exists")
|
|
elif return_code == 2:
|
|
general.log("Failed to create directory")
|
|
elif return_code == 3:
|
|
general.log("Directory length is too long")
|
|
elif return_code != 0:
|
|
general.log("Unknown error, failed to create level")
|
|
else:
|
|
general.log(f"{new_level_name} level created successfully")
|
|
|
|
# Basic setup for newly created level.
|
|
after_level_load()
|
|
initial_viewport_setup(SCREEN_WIDTH, SCREEN_HEIGHT)
|
|
|
|
# Create default_level entity
|
|
search_filter = azlmbr.entity.SearchFilter()
|
|
all_entities = entity.SearchBus(azlmbr.bus.Broadcast, "SearchEntities", search_filter)
|
|
editor.ToolsApplicationRequestBus(bus.Broadcast, "DeleteEntities", all_entities)
|
|
|
|
default_level = hydra.Entity("default_level")
|
|
position = math.Vector3(0.0, 0.0, 0.0)
|
|
default_level.create_entity(position, ["Grid"])
|
|
default_level.get_set_test(0, "Controller|Configuration|Secondary Grid Spacing", 1.0)
|
|
|
|
# Create global_skylight entity and set the properties
|
|
global_skylight = hydra.Entity("global_skylight")
|
|
global_skylight.create_entity(
|
|
entity_position=math.Vector3(0.0, 0.0, 0.0),
|
|
components=["HDRi Skybox", "Global Skylight (IBL)"],
|
|
parent_id=default_level.id
|
|
)
|
|
global_skylight_image_asset_path = os.path.join(
|
|
"LightingPresets", "greenwich_park_02_4k_iblskyboxcm_iblspecular.exr.streamingimage")
|
|
global_skylight_image_asset = asset.AssetCatalogRequestBus(
|
|
bus.Broadcast, "GetAssetIdByPath", global_skylight_image_asset_path, math.Uuid(), False)
|
|
global_skylight.get_set_test(0, "Controller|Configuration|Cubemap Texture", global_skylight_image_asset)
|
|
hydra.get_set_test(global_skylight, 1, "Controller|Configuration|Diffuse Image", global_skylight_image_asset)
|
|
hydra.get_set_test(global_skylight, 1, "Controller|Configuration|Specular Image", global_skylight_image_asset)
|
|
|
|
# Create ground_plane entity and set the properties
|
|
ground_plane = hydra.Entity("ground_plane")
|
|
ground_plane.create_entity(
|
|
entity_position=math.Vector3(0.0, 0.0, 0.0),
|
|
components=["Material"],
|
|
parent_id=default_level.id
|
|
)
|
|
azlmbr.components.TransformBus(azlmbr.bus.Event, "SetLocalUniformScale", ground_plane.id, 32.0)
|
|
ground_plane_material_asset_path = os.path.join("Materials", "Presets", "PBR", "metal_chrome.azmaterial")
|
|
ground_plane_material_asset = asset.AssetCatalogRequestBus(
|
|
bus.Broadcast, "GetAssetIdByPath", ground_plane_material_asset_path, math.Uuid(), False)
|
|
ground_plane.get_set_test(0, "Default Material|Material Asset", ground_plane_material_asset)
|
|
# Work around to add the correct Atom Mesh component
|
|
mesh_type_id = azlmbr.globals.property.EditorMeshComponentTypeId
|
|
ground_plane.components.append(
|
|
editor.EditorComponentAPIBus(
|
|
bus.Broadcast, "AddComponentsOfType", ground_plane.id, [mesh_type_id]
|
|
).GetValue()[0]
|
|
)
|
|
ground_plane_mesh_asset_path = os.path.join("Objects", "plane.azmodel")
|
|
ground_plane_mesh_asset = asset.AssetCatalogRequestBus(
|
|
bus.Broadcast, "GetAssetIdByPath", ground_plane_mesh_asset_path, math.Uuid(), False)
|
|
hydra.get_set_test(ground_plane, 1, "Controller|Configuration|Mesh Asset", ground_plane_mesh_asset)
|
|
|
|
# Create directional_light entity and set the properties
|
|
directional_light = hydra.Entity("directional_light")
|
|
directional_light.create_entity(
|
|
entity_position=math.Vector3(0.0, 0.0, 10.0),
|
|
components=["Directional Light"],
|
|
parent_id=default_level.id
|
|
)
|
|
rotation = math.Vector3(DEGREE_RADIAN_FACTOR * -90.0, 0.0, 0.0)
|
|
azlmbr.components.TransformBus(azlmbr.bus.Event, "SetLocalRotation", directional_light.id, rotation)
|
|
|
|
# Create sphere entity and set the properties
|
|
sphere = hydra.Entity("sphere")
|
|
sphere.create_entity(
|
|
entity_position=math.Vector3(0.0, 0.0, 1.0),
|
|
components=["Material"],
|
|
parent_id=default_level.id
|
|
)
|
|
sphere_material_asset_path = os.path.join("Materials", "Presets", "PBR", "metal_brass_polished.azmaterial")
|
|
sphere_material_asset = asset.AssetCatalogRequestBus(
|
|
bus.Broadcast, "GetAssetIdByPath", sphere_material_asset_path, math.Uuid(), False)
|
|
sphere.get_set_test(0, "Default Material|Material Asset", sphere_material_asset)
|
|
# Work around to add the correct Atom Mesh component
|
|
sphere.components.append(
|
|
editor.EditorComponentAPIBus(
|
|
bus.Broadcast, "AddComponentsOfType", sphere.id, [mesh_type_id]
|
|
).GetValue()[0]
|
|
)
|
|
sphere_mesh_asset_path = os.path.join("Models", "sphere.azmodel")
|
|
sphere_mesh_asset = asset.AssetCatalogRequestBus(
|
|
bus.Broadcast, "GetAssetIdByPath", sphere_mesh_asset_path, math.Uuid(), False)
|
|
hydra.get_set_test(sphere, 1, "Controller|Configuration|Mesh Asset", sphere_mesh_asset)
|
|
|
|
# Create camera component and set the properties
|
|
camera_entity = hydra.Entity("camera")
|
|
position = math.Vector3(5.5, -12.0, 9.0)
|
|
camera_entity.create_entity(components=["Camera"], entity_position=position, parent_id=default_level.id)
|
|
rotation = math.Vector3(
|
|
DEGREE_RADIAN_FACTOR * -27.0, DEGREE_RADIAN_FACTOR * -12.0, DEGREE_RADIAN_FACTOR * 25.0
|
|
)
|
|
azlmbr.components.TransformBus(azlmbr.bus.Event, "SetLocalRotation", camera_entity.id, rotation)
|
|
camera_entity.get_set_test(0, "Controller|Configuration|Field of view", 60.0)
|
|
azlmbr.camera.EditorCameraViewRequestBus(azlmbr.bus.Event, "ToggleCameraAsActiveView", camera_entity.id)
|
|
|
|
# Save level, enter game mode, take screenshot, & exit game mode.
|
|
general.save_level()
|
|
general.idle_wait(0.5)
|
|
general.enter_game_mode()
|
|
general.idle_wait(1.0)
|
|
helper.wait_for_condition(function=lambda: general.is_in_game_mode(), timeout_in_seconds=2.0)
|
|
ScreenshotHelper(general.idle_wait_frames).capture_screenshot_blocking(f"{'AtomBasicLevelSetup'}.ppm")
|
|
general.exit_game_mode()
|
|
helper.wait_for_condition(function=lambda: not general.is_in_game_mode(), timeout_in_seconds=2.0)
|
|
general.log("Basic level created")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
run()
|