UE3:ParticleModuleTypeDataMesh (UDK): Difference between revisions

From Unreal Wiki, The Unreal Engine Documentation Site
Newer edit →
No edit summary
 
No edit summary
Line 9: Line 9:


==Properties==
==Properties==
===Property group 'CameraFacing'===
====bCameraFacing====
'''Type:''' [[bool]]
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.
====CameraFacingOption====
'''Type:''' {{tl|EMeshCameraFacingOptions}}
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.
===Property group 'Mesh'===
===Property group 'Mesh'===
====bAllowMotionBlur====
====bAllowMotionBlur====
Line 39: Line 68:
PSMA_MeshFaceCameraWithLockedAxis
PSMA_MeshFaceCameraWithLockedAxis
Face the camera while maintaining the up vector as the locked direction.
Face the camera while maintaining the up vector as the locked direction.
===Property group 'Orientation'===
====AxisLockOption====
'''Type:''' {{tl|EParticleAxisLock|ParticleModuleOrientationAxisLock}}
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.
====Pitch====
'''Type:''' [[float]]
The 'pre' rotation pitch (in degrees) to apply to the static mesh used.
====Roll====
'''Type:''' [[float]]
The 'pre' rotation roll (in degrees) to apply to the static mesh used.
====Yaw====
'''Type:''' [[float]]
The 'pre' rotation yaw (in degrees) to apply to the static mesh used.


===Internal variables===
===Internal variables===
====CameraFacingUpAxisOption====
'''Type:''' {{tl|EMeshCameraFacingUpAxis}}
'''[[Variables#Modifiers|Modifiers]]:''' deprecated
The axis of the mesh to point up when camera facing the X-axis.
CameraFacing_NoneUP No attempt to face an axis up or down.
CameraFacing_ZUp Z-axis of the mesh should attempt to point up.
CameraFacing_NegativeZUp Z-axis of the mesh should attempt to point down.
CameraFacing_YUp Y-axis of the mesh should attempt to point up.
CameraFacing_NegativeYUp Y-axis of the mesh should attempt to point down.
====CastShadows====
====CastShadows====
'''Type:''' [[bool]]
'''Type:''' [[bool]]
Line 52: Line 124:


==Enums==
==Enums==
====EMeshCameraFacingOptions====
<!-- enter enum description -->
; XAxisFacing_NoUp : <!-- enter enum value description -->
; XAxisFacing_ZUp : <!-- enter enum value description -->
; XAxisFacing_NegativeZUp : <!-- enter enum value description -->
; XAxisFacing_YUp : <!-- enter enum value description -->
; XAxisFacing_NegativeYUp : <!-- enter enum value description -->
; LockedAxis_ZAxisFacing : <!-- enter enum value description -->
; LockedAxis_NegativeZAxisFacing : <!-- enter enum value description -->
; LockedAxis_YAxisFacing : <!-- enter enum value description -->
; LockedAxis_NegativeYAxisFacing : <!-- enter enum value description -->
; VelocityAligned_ZAxisFacing : <!-- enter enum value description -->
; VelocityAligned_NegativeZAxisFacing : <!-- enter enum value description -->
; VelocityAligned_YAxisFacing : <!-- enter enum value description -->
; VelocityAligned_NegativeYAxisFacing : <!-- enter enum value description -->
====EMeshCameraFacingUpAxis====
<!-- enter enum description -->
; CameraFacing_NoneUP : <!-- enter enum value description -->
; CameraFacing_ZUp : <!-- enter enum value description -->
; CameraFacing_NegativeZUp : <!-- enter enum value description -->
; CameraFacing_YUp : <!-- enter enum value description -->
; CameraFacing_NegativeYUp : <!-- enter enum value description -->
====EMeshScreenAlignment====
====EMeshScreenAlignment====
<!-- enter enum description -->
<!-- enter enum description -->

Revision as of 05:24, 17 January 2010

UDK Object >> ParticleModule >> ParticleModuleTypeDataBase >> ParticleModuleTypeDataMesh
Package:
Engine
Direct subclass:
ParticleModuleTypeDataMeshPhysX
This class in other games:
This is an auto-generated page and may need human attention.
Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.


Properties

Property group 'CameraFacing'

bCameraFacing

Type: bool

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.

CameraFacingOption

Type: EMeshCameraFacingOptions

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.

Property group 'Mesh'

bAllowMotionBlur

Type: bool

Allow this mesh emitter to render using motion blur. This adds a velocity rendering pass

bOverrideMaterial

Type: bool

If TRUE, use the emitter material when rendering rather than the one applied to the static mesh model.

Mesh

Type: StaticMesh

The static mesh to render at the particle positions

MeshAlignment

Type: EMeshScreenAlignment

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 vector (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 vector as the locked direction.

Property group 'Orientation'

AxisLockOption

Type: ParticleModuleOrientationAxisLock.EParticleAxisLock

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.

Pitch

Type: float

The 'pre' rotation pitch (in degrees) to apply to the static mesh used.

Roll

Type: float

The 'pre' rotation roll (in degrees) to apply to the static mesh used.

Yaw

Type: float

The 'pre' rotation yaw (in degrees) to apply to the static mesh used.

Internal variables

CameraFacingUpAxisOption

Type: EMeshCameraFacingUpAxis

Modifiers: deprecated

The axis of the mesh to point up when camera facing the X-axis. CameraFacing_NoneUP No attempt to face an axis up or down. CameraFacing_ZUp Z-axis of the mesh should attempt to point up. CameraFacing_NegativeZUp Z-axis of the mesh should attempt to point down. CameraFacing_YUp Y-axis of the mesh should attempt to point up. CameraFacing_NegativeYUp Y-axis of the mesh should attempt to point down.

CastShadows

Type: bool

If TRUE, has the meshes cast shadows

DoCollisions

Type: bool

UNUSED (the collision module dictates doing collisions)

Enums

EMeshCameraFacingOptions

XAxisFacing_NoUp
XAxisFacing_ZUp
XAxisFacing_NegativeZUp
XAxisFacing_YUp
XAxisFacing_NegativeYUp
LockedAxis_ZAxisFacing
LockedAxis_NegativeZAxisFacing
LockedAxis_YAxisFacing
LockedAxis_NegativeYAxisFacing
VelocityAligned_ZAxisFacing
VelocityAligned_NegativeZAxisFacing
VelocityAligned_YAxisFacing
VelocityAligned_NegativeYAxisFacing

EMeshCameraFacingUpAxis

CameraFacing_NoneUP
CameraFacing_ZUp
CameraFacing_NegativeZUp
CameraFacing_YUp
CameraFacing_NegativeYUp

EMeshScreenAlignment

PSMA_MeshFaceCameraWithRoll
PSMA_MeshFaceCameraWithSpin
PSMA_MeshFaceCameraWithLockedAxis
Retrieved from "https://wiki.beyondunreal.com/index.php?title=UE3:ParticleModuleTypeDataMesh_(UDK)&oldid=41260"