Add defaults for render classes

Author: andrzej-krupka

flow360/component/simulation/outputs/output_render_types.py

@@ -4,17 +4,17 @@
 
 import pydantic as pd
 
+import flow360.component.simulation.units as u
 from flow360.component.simulation.framework.base_model import Flow360BaseModel
 from flow360.component.simulation.unit_system import AngleType, LengthType
 from flow360.component.types import Color, Vector
 
 
+
 class StaticCamera(Flow360BaseModel):
     position: LengthType.Point = pd.Field(description="Position of the camera in the scene")
     target: LengthType.Point = pd.Field(description="Target point of the camera")
-    up: Optional[Vector] = pd.Field(
-        default=(0, 1, 0), description="Up vector, if not specified assume Y+"
-    )
+    up: Optional[Vector] = pd.Field(default=(0, 1, 0), description="Up vector, if not specified assume Y+")
 
 
 class Keyframe(Flow360BaseModel):
@@ -47,6 +47,34 @@ class RenderCameraConfig(Flow360BaseModel):
     view: AllCameraTypes = pd.Field()
     projection: Union[OrthographicProjection, PerspectiveProjection] = pd.Field()
 
+    @classmethod
+    def orthographic(cls, x=1, y=1, z=1, scale=1):
+        return RenderCameraConfig(
+            view=StaticCamera(
+                position=(x * scale, y * scale, z * scale) * u.m,
+                target=(0, 0, 0) * u.m
+            ),
+            projection=OrthographicProjection(
+                width=scale * u.m,
+                near=0.01 * u.m,
+                far=50 * scale * u.m
+            )
+        )
+    
+    @classmethod
+    def perspective(cls, x=1, y=1, z=1, scale=1):
+        return RenderCameraConfig(
+            view=StaticCamera(
+                position=(x * scale, y * scale, z * scale) * u.m,
+                target=(0, 0, 0) * u.m
+            ),
+            projection=PerspectiveProjection(
+                fov=60 * u.deg,
+                near=0.01 * u.m,
+                far=50 * scale * u.m
+            )
+        )
+
 
 class AmbientLight(Flow360BaseModel):
     intensity: float = pd.Field()
@@ -63,10 +91,24 @@ class RenderLightingConfig(Flow360BaseModel):
     directional: DirectionalLight = pd.Field()
     ambient: Optional[AmbientLight] = pd.Field(None)
 
+    @classmethod
+    def default(cls):
+        return RenderLightingConfig(
+            ambient=AmbientLight(
+                intensity=0.5,
+                color=(255, 255, 255)
+            ),
+            directional=DirectionalLight(
+                intensity=1.5,
+                color=(255, 255, 255),
+                direction=(-1.0, -1.0, -1.0)
+            )
+        )
+
 
 class RenderBackgroundBase(Flow360BaseModel, metaclass=abc.ABCMeta):
     type: str = pd.Field(default="", frozen=True)
-
+        
 
 class SolidBackground(RenderBackgroundBase):
     type: str = pd.Field(default="solid", frozen=True)
@@ -75,6 +117,7 @@ class SolidBackground(RenderBackgroundBase):
 
 class SkyboxTexture(str, Enum):
     SKY = "sky"
+    GRADIENT = "gradient"
 
 
 class SkyboxBackground(RenderBackgroundBase):
@@ -88,6 +131,30 @@ class SkyboxBackground(RenderBackgroundBase):
 class RenderEnvironmentConfig(Flow360BaseModel):
     background: AllBackgroundTypes = pd.Field()
 
+    @classmethod
+    def simple(cls):
+        return RenderEnvironmentConfig(
+            background=SolidBackground(
+                color=(207, 226, 230)
+            )
+        )
+
+    @classmethod
+    def sky(cls):
+        return RenderEnvironmentConfig(
+            background=SkyboxBackground(
+                texture=SkyboxTexture.SKY
+            )
+        )
+
+    @classmethod
+    def gradient(cls):
+        return RenderEnvironmentConfig(
+            background=SkyboxBackground(
+                texture=SkyboxTexture.GRADIENT
+            )
+        )
+
 
 class RenderMaterialBase(Flow360BaseModel, metaclass=abc.ABCMeta):
     type: str = pd.Field(default="", frozen=True)
@@ -100,6 +167,24 @@ class PBRMaterial(RenderMaterialBase):
     f0: Vector = pd.Field(default=(0.03, 0.03, 0.03))
     type: str = pd.Field(default="pbr", frozen=True)
 
+    @classmethod
+    def metal(cls, shine=0.5, alpha=1.0):
+        return PBRMaterial(
+            color=(255, 255, 255),
+            alpha=alpha,
+            roughness=1 - shine,
+            f0=(0.56, 0.56, 0.56)
+        )
+
+    @classmethod
+    def plastic(cls, shine=0.5, alpha=1.0):
+        return PBRMaterial(
+            color=(255, 255, 255),
+            alpha=alpha,
+            roughness=1 - shine,
+            f0=(0.03, 0.03, 0.03)
+        )
+
 
 class ColorKey(Flow360BaseModel):
     color: Color = pd.Field(default=[255, 255, 255])
@@ -110,10 +195,53 @@ class FieldMaterial(RenderMaterialBase):
     alpha: float = pd.Field(default=1)
     output_field: str = pd.Field(default="")
     min: float = pd.Field(default=0)
-    max: float = pd.Field(default=0)
+    max: float = pd.Field(default=1)
     colormap: List[ColorKey] = pd.Field()
     type: str = pd.Field(default="field", frozen=True)
 
+    @classmethod
+    def greyscale(cls, field, min=0, max=1, alpha=1):
+        return FieldMaterial(
+            alpha=alpha,
+            output_field=field,
+            min=min,
+            max=max,
+            colormap = [
+                ColorKey(color=(0, 0, 0), value=0),
+                ColorKey(color=(255, 255, 255), value=1.0)
+            ]   
+        )
+
+    @classmethod
+    def hot_cold(cls, field, min=0, max=1, alpha=1):
+        return FieldMaterial(
+            alpha=alpha,
+            output_field=field,
+            min=min,
+            max=max,
+            colormap = [
+                ColorKey(color=(0, 0, 255), value=0),
+                ColorKey(color=(255, 255, 255), value=0.5),
+                ColorKey(color=(255, 0, 0), value=1.0)
+            ]   
+        )
+    
+    @classmethod
+    def rainbow(cls, field, min=0, max=1, alpha=1):
+        return FieldMaterial(
+            alpha=alpha,
+            output_field=field,
+            min=min,
+            max=max,
+            colormap = [
+                ColorKey(color=(0, 0, 255), value=0),
+                ColorKey(color=(0, 255, 255), value=0.25),
+                ColorKey(color=(0, 255, 0), value=0.5),
+                ColorKey(color=(255, 255, 0), value=0.75),
+                ColorKey(color=(255, 0, 0), value=1.0)
+            ]   
+        )
+
 
 AllMaterialTypes = Union[PBRMaterial, FieldMaterial]
 

flow360/component/simulation/outputs/outputs.py

@@ -712,13 +712,11 @@ class RenderOutput(_AnimationSettings):
         description="List of output variables. Including "
         ":ref:`universal output variables<UniversalVariablesV2>` and :class:`UserDefinedField`."
     )
-    camera: RenderCameraConfig = pd.Field(description="Camera settings")
-    lighting: RenderLightingConfig = pd.Field(description="Lighting settings")
-    environment: RenderEnvironmentConfig = pd.Field(description="Environment settings")
+    camera: RenderCameraConfig = pd.Field(description="Camera settings", default_factory=RenderCameraConfig.orthographic)
+    lighting: RenderLightingConfig = pd.Field(description="Lighting settings", default_factory=RenderLightingConfig.default)
+    environment: RenderEnvironmentConfig = pd.Field(description="Environment settings", default_factory=RenderEnvironmentConfig.simple)
     materials: RenderMaterialConfig = pd.Field(description="Material settings")
-    transform: Optional[Transform] = pd.Field(
-        None, description="Optional model transform to apply to all entities"
-    )
+    transform: Optional[Transform] = pd.Field(None, description="Optional model transform to apply to all entities")
     output_type: Literal["RenderOutput"] = pd.Field("RenderOutput", frozen=True)
 
 

flow360/component/simulation/translator/solver_translator.py

@@ -579,7 +579,8 @@ def translate_isosurface_output(
 def translate_render_output(
     input_params: SimulationParams,
     output_params: list,
-    injection_function
+    isosurface_injection_function,
+    slice_injection_function
 ):
     """Translate render output settings."""
 
@@ -605,7 +606,7 @@ def translate_render_output(
                 RenderOutput,
                 translation_func=translate_output_fields,
                 to_list=False,
-                entity_injection_func=injection_function,
+                entity_injection_func=isosurface_injection_function,
                 entity_type_to_include=Isosurface,
                 entity_list_attribute_name="isosurfaces",
                 entity_injection_input_params=input_params,
@@ -622,6 +623,7 @@ def translate_render_output(
                 RenderOutput,
                 translation_func=translate_output_fields,
                 to_list=False,
+                entity_injection_func=slice_injection_function,
                 entity_type_to_include=Slice,
             ),
             "camera": remove_units_in_dict(camera),
@@ -1002,7 +1004,12 @@ def translate_output(input_params: SimulationParams, translated: dict):
 
     ##:: Step6: Get translated["renderOutput"]
     if has_instance_in_list(outputs, RenderOutput):
-        translated["renderOutput"] = translate_render_output(input_params, outputs, inject_isosurface_info)
+        translated["renderOutput"] = translate_render_output(
+            input_params, 
+            outputs, 
+            inject_isosurface_info,
+            inject_slice_info
+        )
 
     ##:: Step7: Get translated["monitorOutput"]
     probe_output = {}