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)
Type: float in [0, inf], default 0.0
-
choppiness
¶ Choppiness of the wave’s crest (adds some horizontal component to the displacement)
Type: float in [0, inf], default 0.0
-
damping
¶ Damp reflected waves going in opposite direction to the wind
Type: float in [0, 1], default 0.0
-
depth
¶ Depth of the solid ground below the water surface
Type: float in [-inf, inf], default 0.0
-
filepath
¶ Path to a folder to store external baked images
Type: string, default “”, (never None)
-
foam_coverage
¶ Amount of generated foam
Type: float in [-inf, inf], default 0.0
-
foam_layer_name
¶ Name of the vertex color layer used for foam
Type: string, default “”, (never None)
-
frame_end
¶ End frame of the ocean baking
Type: int in [0, inf], default 0
-
frame_start
¶ Start frame of the ocean baking
Type: int in [0, inf], default 0
-
geometry_mode
¶ Method of modifying geometry
GENERATE
Generate, Generate ocean surface geometry at the specified resolution.DISPLACE
Displace, Displace existing geometry according to simulation.
Type: enum in [‘GENERATE’, ‘DISPLACE’], default ‘GENERATE’
-
is_cached
¶ Whether the ocean is using cached data or simulating
Type: boolean, default False, (readonly)
-
random_seed
¶ Seed of the random generator
Type: int in [0, inf], default 0
-
repeat_x
¶ Repetitions of the generated surface in X
Type: int in [1, 1024], default 0
-
repeat_y
¶ Repetitions of the generated surface in Y
Type: int in [1, 1024], default 0
-
resolution
¶ Resolution of the generated surface
Type: int in [1, 1024], default 0
-
size
¶ Surface scale factor (does not affect the height of the waves)
Type: float in [0, inf], default 0.0
-
spatial_size
¶ Size of the simulation domain (in meters), and of the generated geometry (in BU)
Type: int in [-inf, inf], default 0
-
time
¶ Current time of the simulation
Type: float in [0, inf], default 0.0
-
use_foam
¶ Generate foam mask as a vertex color channel
Type: boolean, default False
-
use_normals
¶ Output normals for bump mapping - disabling can speed up performance if its not needed
Type: boolean, default False
-
wave_alignment
¶ How much the waves are aligned to each other
Type: float in [0, 10], default 0.0
-
wave_direction
¶ Main direction of the waves when they are (partially) aligned
Type: float in [-inf, inf], default 0.0
-
wave_scale
¶ Scale of the displacement effect
Type: float in [0, inf], default 0.0
-
wave_scale_min
¶ Shortest allowed wavelength
Type: float in [0, inf], default 0.0
-
wind_velocity
¶ Wind speed
Type: float in [-inf, inf], default 0.0
-
Inherited Properties
Inherited Functions