OceanModifier(Modifier)

base classes — bpy_struct, Modifier

class bpy.types.OceanModifier(Modifier)

Simulate an ocean surface

bake_foam_fade

How much foam accumulates over time (baked ocean only) (in [0, inf], default 0.98)

Type:

float

choppiness

Choppiness of the wave’s crest (adds some horizontal component to the displacement) (in [0, inf], default 1.0)

Type:

float

damping

Damp reflected waves going in opposite direction to the wind (in [0, 1], default 0.5)

Type:

float

depth

Depth of the solid ground below the water surface (in [-inf, inf], default 200.0)

Type:

float

fetch_jonswap

This is the distance from a lee shore, called the fetch, or the distance over which the wind blows with constant velocity. Used by ‘JONSWAP’ and ‘TMA’ models. (in [0, inf], default 120.0)

Type:

float

filepath

Path to a folder to store external baked images (default “”, never None, blend relative // prefix supported)

Type:

str

foam_coverage

Amount of generated foam (in [-inf, inf], default 0.0)

Type:

float

foam_layer_name

Name of the vertex color layer used for foam (default “”, never None)

Type:

str

frame_end

End frame of the ocean baking (in [-inf, inf], default 250)

Type:

int

frame_start

Start frame of the ocean baking (in [-inf, inf], default 1)

Type:

int

geometry_mode

Method of modifying geometry (default 'GENERATE')

• GENERATE Generate – Generate ocean surface geometry at the specified resolution.

• DISPLACE Displace – Displace existing geometry according to simulation.

Type:

Literal[‘GENERATE’, ‘DISPLACE’]

invert_spray

Invert the spray direction map (default False)

Type:

bool

is_cached

Whether the ocean is using cached data or simulating (default False, readonly)

Type:

bool

random_seed

Seed of the random generator (in [0, inf], default 0)

Type:

int

repeat_x

Repetitions of the generated surface in X (in [1, 1024], default 1)

Type:

int

repeat_y

Repetitions of the generated surface in Y (in [1, 1024], default 1)

Type:

int

resolution

Resolution of the generated surface for rendering and baking (in [1, 1024], default 7)

Type:

int

sharpen_peak_jonswap

Peak sharpening for ‘JONSWAP’ and ‘TMA’ models (in [0, 1], default 0.0)

Type:

float

size

Surface scale factor (does not affect the height of the waves) (in [0, inf], default 1.0)

Type:

float

spatial_size

Size of the simulation domain (in meters), and of the generated geometry (in BU) (in [-inf, inf], default 50)

Type:

int

spectrum

Spectrum to use (default 'PHILLIPS')

• PHILLIPS Turbulent Ocean – Use for turbulent seas with foam.

• PIERSON_MOSKOWITZ Established Ocean – Use for a large area, established ocean (Pierson-Moskowitz method).

• JONSWAP Established Ocean (Sharp Peaks) – Use for established oceans (‘JONSWAP’, Pierson-Moskowitz method) with peak sharpening.

• TEXEL_MARSEN_ARSLOE Shallow Water – Use for shallow water (‘JONSWAP’, ‘TMA’ - Texel-Marsen-Arsloe method).

Type:

Literal[‘PHILLIPS’, ‘PIERSON_MOSKOWITZ’, ‘JONSWAP’, ‘TEXEL_MARSEN_ARSLOE’]

spray_layer_name

Name of the vertex color layer used for the spray direction map (default “”, never None)

Type:

str

time

Current time of the simulation (in [0, inf], default 1.0)

Type:

float

use_foam

Generate foam mask as a vertex color channel (default False)

Type:

bool

use_normals

Output normals for bump mapping - disabling can speed up performance if it’s not needed (default False)

Type:

bool

use_spray

Generate map of spray direction as a vertex color channel (default False)

Type:

bool

viewport_resolution

Viewport resolution of the generated surface (in [1, 1024], default 7)

Type:

int

wave_alignment

How much the waves are aligned to each other (in [0, 1], default 0.0)

Type:

float

wave_direction

Main direction of the waves when they are (partially) aligned (in [-inf, inf], default 0.0)

Type:

float

wave_scale

Scale of the displacement effect (in [0, inf], default 1.0)

Type:

float

wave_scale_min

Shortest allowed wavelength (in [0, inf], default 0.01)

Type:

float

wind_velocity

Wind speed (in [-inf, inf], default 30.0)

Type:

float

classmethod bl_rna_get_subclass(id, default=None, /)

Parameters:

• id (str) – The RNA type identifier.

• default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)

Parameters:

• id (str) – The RNA type identifier.

• default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

bpy_struct.id_data Modifier.name Modifier.type Modifier.show_viewport Modifier.show_render Modifier.show_in_editmode Modifier.show_on_cage

Modifier.show_expanded Modifier.is_active Modifier.use_pin_to_last Modifier.is_override_data Modifier.use_apply_on_spline Modifier.execution_time Modifier.persistent_uid

Inherited Functions

bpy_struct.as_pointer bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.id_properties_clear bpy_struct.id_properties_ensure bpy_struct.id_properties_ui bpy_struct.is_property_hidden bpy_struct.is_property_overridable_library bpy_struct.is_property_readonly bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete

bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_from_module bpy_struct.path_resolve bpy_struct.pop bpy_struct.property_overridable_library_set bpy_struct.property_unset bpy_struct.rna_ancestors bpy_struct.type_recast bpy_struct.values Modifier.bl_rna_get_subclass Modifier.bl_rna_get_subclass_py