unreal.ParticleModuleTypeDataMesh

class unreal.ParticleModuleTypeDataMesh(outer=None, name='None')

Bases: unreal.ParticleModuleTypeDataBase

Particle Module Type Data Mesh

C++ Source:

• Module: Engine

• File: ParticleModuleTypeDataMesh.h

Editor Properties: (see get_editor_property/set_editor_property)

• apply_particle_rotation_as_spin (bool): [Read-Write] If true, apply ‘sprite’ particle rotation about the orientation axis (direction mesh is pointing). If false, apply ‘sprite’ particle rotation about the camera facing axis.

• axis_lock_option (ParticleAxisLock): [Read-Write] The axis to lock the mesh on. This overrides TypeSpecific mesh alignment as well as the LockAxis module.

  EPAL_NONE - No locking to an axis. EPAL_X - Lock the mesh X-axis facing towards +X. EPAL_Y - Lock the mesh X-axis facing towards +Y. EPAL_Z - Lock the mesh X-axis facing towards +Z. EPAL_NEGATIVE_X - Lock the mesh X-axis facing towards -X. EPAL_NEGATIVE_Y - Lock the mesh X-axis facing towards -Y. EPAL_NEGATIVE_Z - Lock the mesh X-axis facing towards -Z. EPAL_ROTATE_X - Ignored for mesh emitters. Treated as EPAL_NONE. EPAL_ROTATE_Y - Ignored for mesh emitters. Treated as EPAL_NONE. EPAL_ROTATE_Z - Ignored for mesh emitters. Treated as EPAL_NONE.

• b3d_draw_mode (bool): [Read-Write] If true, the module should render its 3D visualization helper

• camera_facing (bool): [Read-Write] If true, then point the X-axis of the mesh towards the camera. When set, AxisLockOption as well as all other locked axis/screen alignment settings are ignored.

• camera_facing_option (MeshCameraFacingOptions): [Read-Write] The camera facing option to use: All camera facing options without locked axis assume X-axis will be facing the camera.

  XAxisFacing_NoUp - X-axis camera facing, no attempt to face an axis up or down. XAxisFacing_ZUp - X-axis camera facing, Z-axis of the mesh should attempt to point up. XAxisFacing_NegativeZUp - X-axis camera facing, Z-axis of the mesh should attempt to point down. XAxisFacing_YUp - X-axis camera facing, Y-axis of the mesh should attempt to point up. XAxisFacing_NegativeYUp - X-axis camera facing, Y-axis of the mesh should attempt to point down.

  All axis-locked camera facing options assume the AxisLockOption is set. EPAL_NONE will be treated as EPAL_X.

  LockedAxis_ZAxisFacing - X-axis locked on AxisLockOption axis, rotate Z-axis of the mesh to face towards camera. LockedAxis_NegativeZAxisFacing - X-axis locked on AxisLockOption axis, rotate Z-axis of the mesh to face away from camera. LockedAxis_YAxisFacing - X-axis locked on AxisLockOption axis, rotate Y-axis of the mesh to face towards camera. LockedAxis_NegativeYAxisFacing - X-axis locked on AxisLockOption axis, rotate Y-axis of the mesh to face away from camera.

  All velocity-aligned options do NOT require the ScreenAlignment be set to PSA_Velocity. Doing so will result in additional work being performed… (it will orient the mesh twice).

  VelocityAligned_ZAxisFacing - X-axis aligned to the velocity, rotate the Z-axis of the mesh to face towards camera. VelocityAligned_NegativeZAxisFacing - X-axis aligned to the velocity, rotate the Z-axis of the mesh to face away from camera. VelocityAligned_YAxisFacing - X-axis aligned to the velocity, rotate the Y-axis of the mesh to face towards camera. VelocityAligned_NegativeYAxisFacing - X-axis aligned to the velocity, rotate the Y-axis of the mesh to face away from camera.

• collisions_consider_partilce_size (bool): [Read-Write] If true, all collisions for mesh particle on this emitter will take the particle size into account. If false, particle size will be ignored in collision checks.

• enable_motion_blur (bool): [Read-Write] Enable Motion Blur

• face_camera_direction_rather_than_position (bool): [Read-Write] If true, all camera facing options will point the mesh against the camera’s view direction rather than pointing at the cameras location. If false, the camera facing will point to the cameras position as normal.

• lod_size_scale (float): [Read-Write] use the static mesh’s LOD setup and switch LODs based on largest particle’s screen size

• mesh (StaticMesh): [Read-Write] The static mesh to render at the particle positions

• mesh_alignment (MeshScreenAlignment): [Read-Write] The alignment to use on the meshes emitted. The RequiredModule->ScreenAlignment MUST be set to PSA_TypeSpecific to use. One of the following: PSMA_MeshFaceCameraWithRoll

  Face the camera allowing for rotation around the mesh-to-camera FVector (amount provided by the standard particle sprite rotation).

  PSMA_MeshFaceCameraWithSpin

  Face the camera allowing for the mesh to rotate about the tangential axis.

  PSMA_MeshFaceCameraWithLockedAxis

  Face the camera while maintaining the up FVector as the locked direction.

• module_editor_color (Color): [Read-Write] The color to draw the modules curves in the curve editor.

  If bCurvesAsColor is true, it overrides this value.

• override_default_motion_blur_settings (bool): [Read-Write] Override Default Motion Blur Settings

• override_material (bool): [Read-Write] If true, use the emitter material when rendering rather than the one applied to the static mesh model.

• roll_pitch_yaw_range (RawDistributionVector): [Read-Write] The ‘pre’ rotation pitch (in degrees) to apply to the static mesh used.

• use_static_mesh_lo_ds (bool): [Read-Write] use the static mesh’s LOD setup and switch LODs based on largest particle’s screen size

get_particle_module_type_data_mesh_props() -> (out_mesh=StaticMesh, out_lod_size_scale=float, out_use_static_mesh_lo_ds=bool, out_cast_shadows=bool, out_do_collisions=bool, out_mesh_alignment=MeshScreenAlignment, out_override_material=bool, out_override_default_motion_blur_settings=bool, out_enable_motion_blur=bool, out_roll_pitch_yaw_range=Distribution, out_axis_lock_option=ParticleAxisLock, out_camera_facing=bool, out_camera_facing_up_axis_option=MeshCameraFacingUpAxis, out_camera_facing_option=MeshCameraFacingOptions, out_apply_particle_rotation_as_spin=bool, out_facing_camera_direction_rather_than_position=bool, out_collisions_consider_particle_size=bool)

Get Particle Module Type Data Mesh Props

Returns

out_mesh (StaticMesh):

out_lod_size_scale (float):

out_use_static_mesh_lo_ds (bool):

out_cast_shadows (bool):

out_do_collisions (bool):

out_mesh_alignment (MeshScreenAlignment):

out_override_material (bool):

out_override_default_motion_blur_settings (bool):

out_enable_motion_blur (bool):

out_roll_pitch_yaw_range (Distribution):

out_axis_lock_option (ParticleAxisLock):

out_camera_facing (bool):

out_camera_facing_up_axis_option (MeshCameraFacingUpAxis):

out_camera_facing_option (MeshCameraFacingOptions):

out_apply_particle_rotation_as_spin (bool):

out_facing_camera_direction_rather_than_position (bool):

out_collisions_consider_particle_size (bool):

Return type

tuple