Difference between revisions of "UE3:SkeletalMeshComponent properties (UDK)"

Revision as of 05:24, 17 January 2010 (edit) (Talk) ← Older edit	Latest revision as of 05:48, 17 January 2010 (edit) (undo) Wormbo (Talk | contribs) m (1 revision: class descriptions for UDK January update (part 5))
(No difference)

---

Latest revision as of 05:48, 17 January 2010

;Other member categories for this class::internal variables, native functions

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[edit]

Property group 'Cloth'[edit]

bAttachClothVertsToBaseBody[edit]

Type: bool

If true, fixed verts of the cloth are attached in the physics to the physics body that this components actor is attached to.

bAutoFreezeClothWhenNotRendered[edit]

Type: bool

If true, cloth will automatically have bClothFrozen set when it is not rendered, and have it turned off when it is seen.

Default value: True

bClothAwakeOnStartup[edit]

Type: bool

If true, cloth will be awake when a level is started, otherwise it will be instantly put to sleep.

bClothBaseVelClamp[edit]

Type: bool

It true, clamp velocity of cloth particles to be within ClothBaseVelClampRange of Base velocity.

bClothBaseVelInterp[edit]

Type: bool

It true, interp velocity of cloth particles towards Base velocity, using ClothBaseVelClampRange as the interp rate (0..1).

bClothFrozen[edit]

Type: bool

Modifiers: const

If true, cloth is 'frozen' and no simulation is taking place for it, though it will keep its shape.

bClothPositionalDampening[edit]

Type: bool

Whether should do positional box dampening

bClothUseCompartment[edit]

Type: bool

Modifiers: const

If TRUE, soft body uses compartment in physics scene (usually with fixed timstep for better behaviour)

bClothWindRelativeToOwner[edit]

Type: bool

Whether wind direction is relative to owner rotation or not

bDisableClothCollision[edit]

Type: bool

Modifiers: const

Turns off all cloth collision so not checks are done (improves performance).

bEnableClothSimulation[edit]

Type: bool

Modifiers: const

Whether cloth simulation should currently be used on this SkeletalMeshComponent.

See: SetEnableClothSimulation

bIsClothOnStaticObject[edit]

Type: bool

Whether this cloth is on a non-animating static object.

ClothAttachmentTearFactor[edit]

Type: float

Modifiers: const

The cloth tear factor for this SkeletalMeshComponent, negative values take the tear factor from the SkeletalMesh. Note: UpdateClothParams() should be called after modification so that the changes are reflected in the simulation.

Default value: -1.0

ClothBaseVelClampRange[edit]

Type: Object.Vector

If bClothBaseVelClamp is TRUE, amount of variance from base's velocity the cloth is allowed. If bClothBaseVelInterp is TRUE, how fast cloth verts are pushed towards base velocity (0..1)

ClothBlendMaxDistanceFactor[edit]

Type: float

Distance factor above which cloth should be fully simulated.

ClothBlendMinDistanceFactor[edit]

Type: float

Distance factor below which cloth should be fully animated. -1.0 indicates always physics.

Default value: -1.0

ClothBlendWeight[edit]

Type: float

How much to blend in results from cloth simulation with results from regular skinning.

Default value: 1.0

ClothExternalForce[edit]

Type: Object.Vector

Modifiers: const

Constant force applied to all vertices in the cloth.

ClothForceScale[edit]

Type: float

Modifiers: const

How much force to apply to cloth, in relation to the force(from a force field) applied to rigid bodies(zero applies no force to cloth, 1 applies the same)

ClothImpulseScale[edit]

Type: float

Amount to scale impulses applied to cloth simulation.

Default value: 1.0

ClothRBChannel[edit]

Type: PrimitiveComponent.ERBCollisionChannel

Modifiers: const

Enum indicating what type of object this cloth should be considered for rigid body collision.

Default value: RBCC_Cloth

ClothRBCollideWithChannels[edit]

Type: PrimitiveComponent.RBCollisionChannelContainer

Modifiers: const

Types of objects that this cloth will collide with.

ClothWind[edit]

Type: Object.Vector

'Wind' force applied to cloth. Force on each vertex is based on the dot product between the wind vector and the surface normal.

MaxPosDampRange[edit]

Type: Object.Vector

Distance from the owner in relative frame (max == pos XYZ, min == neg XYZ)

MaxPosDampScale[edit]

Type: Object.Vector

Dampening scale applied to cloth particle velocity when approaching boundaries of *PosDampRange

MinDistanceForClothReset[edit]

Type: float

Modifiers: const

If the distance traveled between frames exceeds this value the vertices will be reset to avoid stretching.

Default value: 256.0

MinPosDampRange[edit]

Type: Object.Vector

Distance from the owner in relative frame (max == pos XYZ, min == neg XYZ)

MinPosDampScale[edit]

Type: Object.Vector

Dampening scale applied to cloth particle velocity when approaching boundaries of *PosDampRange

Property group 'SkeletalMeshComponent'[edit]

Animations[edit]

Type: AnimNode

Modifiers: const, editinline, export

This is the unique instance of the AnimTree used by this SkeletalMeshComponent. THIS SHOULD NEVER POINT TO AN ANIMTREE IN A CONTENT PACKAGE.

AnimSets[edit]

Type: array<AnimSet>

The set of AnimSets that will be looked in to find a particular sequence, specified by name in an AnimNodeSequence. Array is search from last to first element, so you can replace a particular sequence but putting a set containing the new version later in the array. You will need to call SetAnim again on nodes that may be affected by any changes you make to this array.

AnimTreeTemplate[edit]

Type: AnimTree

Modifiers: const

This should point to the AnimTree in a content package. BeginPlay on this SkeletalMeshComponent will instance (copy) the tree and assign the instance to the Animations pointer.

bConsiderAllBodiesForBounds[edit]

Type: bool

If TRUE, when updating bounds from a PhysicsAsset, consider _all_ BodySetups, not just those flagged with bConsiderForBounds.

bDisableFaceFXMaterialInstanceCreation[edit]

Type: bool

If true, FaceFX will not automatically create material instances.

bEnableFullAnimWeightBodies[edit]

Type: bool

Enables blending in of physics bodies with the bAlwaysFullAnimWeight flag set. (e.g. hair and other flappy bits!)

bForceDiscardRootMotion[edit]

Type: bool

force root motion to be discarded, no matter what the AnimNodeSequence(s) are set to do

bForceUpdateAttachmentsInTick[edit]

Type: bool

If true, attachments will be updated twice a frame - once in Tick and again when UpdateTransform is called. This can resolve some 'frame behind' issues if an attachment need to be in the correct location for it's Tick, but at a cost.

bHasPhysicsAssetInstance[edit]

Type: bool

Modifiers: const

Indicates whether this SkeletalMeshComponent should have a physics engine representation of its state.

See: SetHasPhysicsAssetInstance

bNoSkeletonUpdate[edit]

Type: bool

Skip UpdateSkelPose.

bPerBoneVolumeEffects[edit]

Type: bool

If true, when this skeletal mesh overlaps a physics volume, each body of it will be tested against the volume, so only limbs actually in the volume will be affected. Useful when gibbing bodies.

bSyncActorLocationToRootRigidBody[edit]

Type: bool

If true, will move the Actors Location to match the root rigid body location when in PHYS_RigidBody.

Default value: True

bUpdateJointsFromAnimation[edit]

Type: bool

If we should pass joint position to joints each frame, so that they can be used by motorized joints to drive the ragdoll based on the animation.

bUpdateKinematicBonesFromAnimation[edit]

Type: bool

If we are running physics, should we update bFixed bones based on the animation bone positions.

Default value: True

bUpdateSkelWhenNotRendered[edit]

Type: bool

If true, update skeleton/attachments even when our Owner has not been rendered recently

Note: In the output from SHOWSKELCOMPTICKTIME you want UpdatePoseTotal to be 0 when this is FALSE for a specific component

Default value: True

FaceFXBlendMode[edit]

Type: EFaceFXBlendMode

How FaceFX transforms should be blended with skeletal mesh

Default value: FXBM_Additive

ForcedLodModel[edit]

Type: int

If 0, auto-select LOD level. if >0, force to (ForcedLodModel-1).

GlobalAnimRateScale[edit]

Type: float

Used to scale speed of all animations on this skeletal mesh.

Default value: 1.0

MinLodModel[edit]

Type: int

This is the min LOD that this component will use. (e.g. if set to 2 then only 2+ LOD Models will be used.) This is useful to set on meshes which are known to be a certain distance away and still want to have better LODs when zoomed in on them.

MorphSets[edit]

Type: array<MorphTargetSet>

Array of MorphTargetSets that will be looked in to find a particular MorphTarget, specified by name. It is searched in the same way as the AnimSets array above.

ParentAnimComponent[edit]

Type: SkeletalMeshComponent

Modifiers: const

If set, this SkeletalMeshComponent will not use its Animations pointer to do its own animation blending, but will use the SpaceBases array in the ParentAnimComponent. This is used when constructing a character using multiple skeletal meshes sharing the same skeleton within the same Actor.

PhysicsAsset[edit]

Type: PhysicsAsset

Modifiers: const

Physics and collision information used for this SkeletalMesh, set up in PhAT. This is used for per-bone hit detection, accurate bounding box calculation and ragdoll physics for example.

PhysicsWeight[edit]

Type: float

Modifiers: interp

Influence of rigid body physics on the mesh's pose (0.0 == use only animation, 1.0 == use only physics)

RootMotionMode[edit]

Type: ERootMotionMode

Default value: RMM_Ignore

RootMotionRotationMode[edit]

Type: ERootMotionRotationMode

SkeletalMesh[edit]

Type: SkeletalMesh

The skeletal mesh used by this component.

WireframeColor[edit]

Type: Object.Color

Default value:

Member	Value
A	255
B	28
G	221
R	221

Property group 'Softbody'[edit]

bAutoFreezeSoftBodyWhenNotRendered[edit]

Type: bool

If true, the soft-body will automatically have bSoftBodyFrozen set when it is not rendered, and have it turned off when it is seen.

bEnableSoftBodySimulation[edit]

Type: bool

Modifiers: const

Whether soft-body simulation should currently be used on this SkeletalMeshComponent.

bSoftBodyAwakeOnStartup[edit]

Type: bool

If true, the soft-body will be awake when a level is started, otherwise it will be instantly put to sleep.

bSoftBodyFrozen[edit]

Type: bool

Modifiers: const

If true, the soft-body is 'frozen' and no simulation is taking place for it, though it will keep its shape.

bSoftBodyUseCompartment[edit]

Type: bool

Modifiers: const

If TRUE, soft body uses compartment in physics scene (usually with fixed timstep for better behaviour)

Default value: True

SoftBodyImpulseScale[edit]

Type: float

Amount to scale impulses applied to soft body simulation.

Default value: 1.0

SoftBodyRBChannel[edit]

Type: PrimitiveComponent.ERBCollisionChannel

Modifiers: const

Enum indicating what type of object this soft-body should be considered for rigid body collision.

Default value: RBCC_SoftBody

SoftBodyRBCollideWithChannels[edit]

Type: PrimitiveComponent.RBCollisionChannelContainer

Modifiers: const

Types of objects that this soft-body will collide with.

Internal variables[edit]

See SkeletalMeshComponent internal variables.

Default values[edit]

Property	Value
bAcceptsDynamicDecals	False
bCullModulatedShadowOnBackfaces	False
TickGroup	TG_PreAsyncWork