Engine.SkeletalMesh

Extends

Object

Modifiers

native ( SkeletalMesh ) noexport dependson ( ApexClothingAsset ) hidecategories ( Object )

Contains the shared data that is used by all SkeletalMeshComponents (instances). Copyright 1998-2011 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Engine.SkeletalMesh

bHasVertexColors Source code

Whether or not the mesh has vertex colors

Bounds Source code

CachedSoftBodyMeshes Source code

Cache of pointers to NxSoftBodyMesh objects at different scales.

CachedSoftBodyMeshScales Source code

Scale of each of the NxSoftBodyMesh objects in cache. This array is same size as CachedSoftBodyMeshes.

CachedStreamingTextureFactors Source code

The cached streaming texture factors. If the array doesn't have MAX_TEXCOORDS entries in it, the cache is outdated.

ClothIndexBuffer Source code

Index buffer for simulation cloth.

ClothMesh Source code

Cache of ClothMesh objects at different scales.

ClothMeshScale Source code

Scale of each of the ClothMesh objects in cache. This array is same size as ClothMesh.

ClothMovementScale Source code

Scaling (per vertex) for how far cloth vert can move from its animated position

ClothToGraphicsVertMap Source code

Mapping between each vertex in the simulation mesh and the graphics mesh. This is ordered so that 'free' vertices are first, and then after NumFreeClothVerts they are 'fixed' to the skinned mesh.

ClothTornTriMap Source code

Map which maps from a set of 3 triangle indices packet in a 64bit to the location in the index buffer, Used to update indices for torn triangles. Note: This structure is lazy initialized when a torn cloth mesh is created. (But could be precomputed in BuildClothMapping() if serialization is handled correctly).

ClothWeldedIndices Source code

This will hold the indices to the reduced number of cloth vertices used for cooking the NxClothMesh.

ClothWeldingDomain Source code

This is the highest value stored in ClothWeldingMap

ClothWeldingMap Source code

Mapping from index of rendered mesh to index of simulated mesh. This mapping applies before ClothToGraphicsVertMap which can then operate normally The reason for this mapping is to weld several vertices with the same position but different texture coordinates into one simulated vertex which makes it possible to run closed meshes for cloth.

GraphicsIndexIsCloth Source code

Saves if Graphics Vertex is simulated cloth or not

LODModels Source code

NameIndexMap Source code

NumFreeClothVerts Source code

Point in the simulation cloth vertex array where the free verts finish and we start having 'fixed' verts.

PerPolyBoneKDOPs Source code

KDOP tree's used for storing rigid triangle information for a subset of bones. Length of this array matches PerPolyCollisionBones

RefBasesInvMatrix Source code

RefSkeleton Source code

ReleaseResourcesFence Source code

SkeletalDepth Source code

SkelMeshRUID Source code

Runtime UID for this SkeletalMeshm, used when linking meshes to AnimSets.

Sockets Source code

SoftBodySurfaceIndices Source code

Index buffer of the triangles of the soft-body's surface mesh. Indices refer to entries in SoftBodySurfaceToGraphicsVertMap.

SoftBodySurfaceToGraphicsVertMap Source code

Mapping between each vertex of the simulated soft-body's surface-mesh and the graphics mesh.

SoftBodyTetraIndices Source code

Index buffer of the tetrahedra of the soft-body's tetra-mesh. Indices refer to the vertices in SoftBodyTetraVertsUnscaled.

SoftBodyTetraLinks Source code

Mapping between each vertex of the surface-mesh and its tetrahedron, with local positions given in barycentric coordinates.

SoftBodyTetraVertsUnscaled Source code

Base array of tetrahedron vertex positions. Used to generate the scaled versions from.

Cloth

bEnableClothBendConstraints Source code

Enable constraints that attempt to minimize curvature or folding of the cloth.

bEnableClothDamping Source code

Enable damping forces on the cloth.

bEnableClothLineChecks Source code

Enable cloth line/extent/point checks. Note: line checks are performed with a raycast against the cloth, but point and swept extent checks are performed against the cloth AABB

bEnableClothTearing Source code

Used to enable cloth tearing. Note, extra vertices/indices must be reserved using ClothTearReserve Also cloth tearing is not available when welding is enabled.

bEnableValidBounds Source code

Any cloth vertex that exceeds its valid bounds will be deleted if bEnableValidBounds is set. Tune ValidBoundMin and ValidBoundMax if valid bound is enabled.

bHardStretchLimit Source code

If TRUE, limit the total amount of stretch that is allowed in the cloth, based on HardStretchLimitFactor. Note that bLimitClothToAnimMesh must be TRUE for this to work.

bLimitClothToAnimMesh Source code

If TRUE, simulated verts are limited to a certain distance from

bUseClothCOMDamping Source code

Enable center of mass damping of cloth internal velocities.

ClothBendStiffness Source code

Controls strength of springs that stop the cloth from bending. bEnableClothBendConstraints must be true to take affect.

ClothBones Source code

Vertices with any weight to these bones are considered 'cloth'.

ClothDamping Source code

Controls how much damping force is applied to cloth particles. bEnableClothDamping must be true to take affect.

ClothDensity Source code

This is multiplied by the size of triangles sharing a point to calculate the points mass. This cannot be modified after the cloth has been created.

ClothFriction Source code

Controls movement of cloth when in contact with other bodies.

ClothHierarchicalIterations Source code

If ClothHierarchyLevels is more than 0, this number controls the number of iterations of the hierarchical solver.

ClothHierarchyLevels Source code

If greater than 1, will generate smaller meshes internally, used to improve simulation time and reduce stretching.

ClothIterations Source code

Increasing the number of solver iterations improves how accurately the cloth is simulated, but will also slow down simulation.

ClothMovementScaleGenMode Source code

Method to use to generate the ClothMovementScale table

ClothStretchStiffness Source code

Controls strength of springs that attempts to keep particles in the cloth together.

ClothTearFactor Source code

Stretch factor beyond which a cloth edge/vertex will tear. Should be greater than 1.

ClothTearReserve Source code

Number of vertices/indices to set aside to accomodate new triangles created as a result of tearing

ClothThickness Source code

How thick the cloth is considered when doing collision detection.

ClothToAnimMeshMaxDist Source code

How far a simulated vertex can move from its animated location

HardStretchLimitFactor Source code

If bHardStretchLimit is TRUE, how much stretch is allowed in the cloth. 1.0 is no stretch (but will cause jitter)

ValidBoundsMax Source code

The maximum coordinates triplet of the cloth valid bound

ValidBoundsMin Source code

The minimum coordinates triplet of the cloth valid bound

ClothAdvanced

bClothMetal Source code

Whether cloth simulation should be wrapped inside a Rigid Body and only be used upon impact

bEnableClothOrthoBendConstraints Source code

Enable orthogonal bending resistance to minimize curvature or folding of the cloth. This technique uses angular springs instead of distance springs as used in 'bEnableClothBendConstraints'. This mode is slower but independent of stretching resistance.

bEnableClothPressure Source code

Enables pressure support. Simulates inflated objects like balloons.

bEnableClothSelfCollision Source code

Enables cloth self collision.

bEnableClothTwoWayCollision Source code

Enables two way collision with rigid-bodies.

bForceNoWelding Source code

Forces the Welding Code to be turned off even if the mesh has doubled vertices

ClothAttachmentResponseCoefficient Source code

How much an attachment to a rigid body influences the cloth

ClothAttachmentTearFactor Source code

How much extension an attachment can undergo before it tears/breaks

ClothCollisionResponseCoefficient Source code

Response coefficient for cloth/rb collision

ClothMetalImpulseThreshold Source code

Threshold for when deformation is allowed

ClothMetalMaxDeformationDistance Source code

Maximum deviation of cloth particles from initial position

ClothMetalPenetrationDepth Source code

Amount by which colliding objects are brought closer to the cloth

ClothPressure Source code

Adjusts the internal "air" pressure of the cloth. Only has affect when bEnableClothPressure.

ClothRelativeGridSpacing Source code

Controls the size of the grid cells a cloth is divided into when performing broadphase collision. The cell size is relative to the AABB of the cloth.

ClothSleepLinearVelocity Source code

Maximum linear velocity at which cloth can go to sleep. If negative, the global default will be used.

ClothSpecialBones Source code

Vertices with any weight to these bones are considered cloth with special behavoir, currently they are attached to the physics asset with fixed or breakable attachments or tearlines.

SkeletalMesh

AddToParentPerPolyCollisionBone Source code

For each of these bones, find the parent that is in PerPolyCollisionBones and add its polys to that bone.

bForceCPUSkinning Source code

All meshes default to GPU skinning. Set to True to enable CPU skinning. If CPU skinning is enabled, bUsePackedPosition can't be enabled

BoneBreakNames Source code

Array of bone names that break for use in game/editor

BoneBreakOptions Source code

Match with BoneBreakNames array

BoundsPreviewAsset Source code

Asset used for previewing bounds in AnimSetViewer. Makes setting up LOD distance factors more reliable.

bPerPolyUseSoftWeighting Source code

If true, include triangles that are soft weighted to bones.

bUseFullPrecisionUVs Source code

If true, use 32 bit UVs. If false, use 16 bit UVs to save memory

bUsePackedPosition Source code

If true, use compressed position XYZs(4 bytes saving 8 bytes). This is only useful for GPU skinning.

bUseSimpleBoxCollision Source code

If true, use PhysicsAsset for extent (swept box) collision checks. If false, use per-poly bone collision (if present).

bUseSimpleLineCollision Source code

If true, use PhysicsAsset for line collision checks. If false, use per-poly bone collision (if present).

ClothingAssets Source code

List of clothing assets associated with each material int this mesh.

FaceFXAsset Source code

The FaceFX asset the skeletal mesh uses for FaceFX operations.

LODBiasPC Source code

LOD bias to use for PC.

LODBiasPS3 Source code

LOD bias to use for PS3.

LODBiasXbox360 Source code

LOD bias to use for Xbox 360.

LODInfo Source code

Struct containing information for each LOD level, such as materials to use, whether to cast shadows, and when use the LOD.

Materials Source code

List of materials applied to this mesh.

Origin Source code

Origin in original coordinate system

PerPolyCollisionBones Source code

For each bone specified here, all triangles rigidly weighted to that bone are entered into a kDOP, allowing per-poly collision checks.

PreviewMorphSets Source code

Asset used for previewing morph target animations in AnimSetViewer. Only for editor.

RotOrigin Source code

Amount to rotate when importing (mostly for yawing)

SkelMirrorAxis Source code

SkelMirrorFlipAxis Source code

SkelMirrorTable Source code

List of bones that should be mirrored.

SourceFilePath Source code

Path to the resource used to construct this skeletal mesh

SourceFileTimestamp Source code

Date/Time-stamp of the file from the last import

StreamingDistanceMultiplier Source code

Allows artists to adjust the distance where textures using UV 0 are streamed in/out. 1.0 is the default, whereas a higher value increases the streamed-in resolution.

SoftBody

bEnableSoftBodyDamping Source code

Enable damping forces on the softbody.

bEnableSoftBodyLineChecks Source code

Enable soft body line checks.

bEnableSoftBodySelfCollision Source code

Enables soft-body self collision.

bEnableSoftBodyTwoWayCollision Source code

Enables two way collision with rigid-bodies.

bSoftBodyIsoSurface Source code

If enabled, an iso-surface is generated around the original graphics-mesh before the tetrahedron-mesh is created.

bUseSoftBodyCOMDamping Source code

Enable center of mass damping of SoftBody internal velocities.

SoftBodyAttachmentResponse Source code

Defines a factor for the impulse transfer from the soft body to attached rigid bodies. bEnableSoftBodyTwoWayCollision must be true to take effect.

SoftBodyAttachmentTearFactor Source code

How much extension an attachment can undergo before it tears/breaks

SoftBodyAttachmentThreshold Source code

Specifies the maximum distance a tetra-vertex is allowed to have from the surface-mesh to still end up attached to a bone.

SoftBodyBones Source code

Vertices with any weight to these bones are considered 'soft-body'.

SoftBodyCollisionResponse Source code

Defines a factor for the impulse transfer from the soft body to colliding rigid bodies. bEnableSoftBodyTwoWayCollision must be true to take effect.

SoftBodyDamping Source code

Controls how much damping force is applied to soft-body particles. bEnableSoftBodyDamping must be true to take affect.

SoftBodyDensity Source code

Density of the soft-body (mass per volume).

SoftBodyDetailLevel Source code

Controls how much the original graphics mesh is simplified before it is used to seed to tetrahedron-mesh generator.

SoftBodyFriction Source code

Controls movement of soft-body when in contact with other bodies.

SoftBodyParticleRadius Source code

Size of the soft-body particles used for collision detection.

SoftBodyRelativeGridSpacing Source code

Controls the size of the grid cells a soft-body is divided into when performing broadphase collision. The cell size is relative to the AABB of the soft-body.

SoftBodySleepLinearVelocity Source code

Maximum linear velocity at which a soft-body can go to sleep. If negative, the global default will be used.

SoftBodySolverIterations Source code

Increasing the number of solver iterations improves how accurately the soft-body is simulated, but will also slow down simulation.

SoftBodySpecialBones Source code

Vertices with any weight to these bones are considered softbody with special behavoir, currently they are attached to the physics asset with fixed or breakable attachments.

SoftBodyStretchingStiffness Source code

Defines how strongly the soft-body resists stretching motions. Range (0,1].

SoftBodySubdivisionLevel Source code

Controls how many tetrahedra are generated to approximate the surface-mesh.

SoftBodyVolumeStiffness Source code

Defines how strongly the soft-body resists motion that changes the rest volume. Range (0,1].

BoneBreakOption Source code

ClothBoneType Source code

Cloth bone type, used when attaching to the physics asset.

ClothMovementScaleGen Source code

Enum indicating which method to use to generate per-vertex cloth vert movement scale (ClothMovementScale)

SoftBodyBoneType Source code

Cloth bone type, used when attaching to the physics asset.

TriangleSortAxis Source code

Enum to specify which axis to use for the forward vector when using TRISORT_CustomLeftRight sort mode

TriangleSortOption Source code

BoneMirrorExport Source code

Structure to export/import bone mirroring information

BoneMirrorInfo Source code

BoneFlipAxis:

Axis the bone is mirrored across.

SourceIndex:

The bone to mirror.

ClothSpecialBoneInfo Source code

Used to specify a set of special cloth bones which are attached to the physics asset
AttachedVertexIndices:

Array used to cache cloth indices which will be attached to this bone, created in BuildClothMapping(), Note: These are welded indices.

BoneName:

The bone name to attach to a cloth vertex

BoneType:

The type of attachment

SkeletalMeshLODInfo Source code

Struct containing information for a particular LOD level, such as materials and info for when to use it.
bEnableShadowCasting:

Per-section control over whether to enable shadow casting.

DisplayFactor:

Indicates when to use this LOD. A smaller number means use this LOD when further away.

LODHysteresis:

Used to avoid 'flickering' when on LOD boundary. Only taken into account when moving from complex->simple.

LODMaterialMap:

Mapping table from this LOD's materials to the SkeletalMesh materials array.

TriangleSorting:

Per-section sorting options

SoftBodySpecialBoneInfo Source code

Used to specify a set of special softbody bones which are attached to the physics asset
AttachedVertexIndices:

Array used to cache softbody indices which will be attached to this bone, created in BuildSoftBodyMapping(), Note: These are welded indices.

BoneName:

The bone name to attach to a cloth vertex

BoneType:

The type of attachment

SoftBodyTetraLink Source code

TriangleSortSettings Source code

Struct containing triangle sort settings for a particular section

defaultproperties
{
	SkelMirrorAxis=AXIS_X
	SkelMirrorFlipAxis=AXIS_Z
	
	ClothThickness = 0.5
	ClothDensity = 1.0
	ClothBendStiffness = 1.0
	ClothStretchStiffness = 1.0
    ClothDamping = 0.5
	ClothFriction = 0.5
    ClothIterations = 5
	ClothHierarchicalIterations = 2

	HardStretchLimitFactor = 1.1

	ClothMovementScaleGenMode=ECMDM_DistToFixedVert

	bUseSimpleLineCollision=true
	bUseSimpleBoxCollision=true

	bEnableClothOrthoBendConstraints = FALSE
	bEnableClothSelfCollision = FALSE
	bEnableClothPressure = FALSE
	bEnableClothTwoWayCollision = FALSE
	bForceNoWelding = FALSE
	
	ClothRelativeGridSpacing = 1.0
	ClothPressure = 1.0
	ClothCollisionResponseCoefficient = 0.2
	ClothAttachmentResponseCoefficient = 0.2
	ClothAttachmentTearFactor = 1.5
	ClothSleepLinearVelocity =-1.0

	ClothMetalImpulseThreshold=10.0
	ClothMetalPenetrationDepth=0.0
	ClothMetalMaxDeformationDistance=0.0

	bEnableClothTearing = FALSE
	ClothTearFactor = 3.5
	ClothTearReserve = 128
	
	bEnableValidBounds=FALSE
	ValidBoundsMin=(X=0,Y=0,Z=0)
	ValidBoundsMax=(X=0,Y=0,Z=0)
	
	SoftBodyVolumeStiffness = 1.0;
	SoftBodyStretchingStiffness = 1.0;
	SoftBodyDensity = 1.0;
	SoftBodyParticleRadius = 0.1;
	SoftBodyDamping = 0.5;
	SoftBodySolverIterations = 5;
	SoftBodyFriction = 0.5
	SoftBodyRelativeGridSpacing = 1.0
	SoftBodySleepLinearVelocity = -1.0
	bEnableSoftBodySelfCollision = FALSE
	SoftBodyAttachmentResponse = 0.2;
	SoftBodyCollisionResponse = 0.2;
	
	SoftBodyDetailLevel = 0.5f;
	SoftBodySubdivisionLevel = 4
	bSoftBodyIsoSurface = TRUE
	
	SoftBodyAttachmentThreshold = 0.5;
	bEnableSoftBodyTwoWayCollision = TRUE;

	SoftBodyAttachmentTearFactor = 1.5;

	StreamingDistanceMultiplier = 1.0;

	bUsePackedPosition = TRUE
}