Engine.RB_BodyInstance

Extends

Object

Modifiers

hidecategories ( Object ) native ( Physics )

Copyright 1998-2011 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Engine.RB_BodyInstance

Functions Summary
		EnableBoneSpring (bool bInEnableLinear, bool bInEnableAngular, const out matrix InBoneTarget)
		EnableCollisionResponse (bool bEnableResponse)
	float	GetBodyMass ()
	PhysicsAssetInstance	GetPhysicsAssetInstance ()
	vector	GetUnrealWorldAngularVelocity ()
	matrix	GetUnrealWorldTM ()
	vector	GetUnrealWorldVelocity ()
	vector	GetUnrealWorldVelocityAtPoint (vector Point)
	bool	IsFixed ()
	bool	IsValidBodyInstance ()
		SetBlockRigidBody (bool bNewBlockRigidBody)
		SetBoneSpringParams (float InLinearSpring, float InLinearDamping, float InAngularSpring, float InAngularDamping)
		SetBoneSpringTarget (const out matrix InBoneTarget, bool bTeleport)
		SetContactReportForceThreshold (FLOAT Threshold)
		SetFixed (bool bNewFixed)
		SetPhysMaterialOverride (PhysicalMaterial NewPhysMaterial)
		UpdateDampingProperties ()
		UpdateMassProperties (RB_BodySetup Setup)

bForceUnfixed Source code

An override to say whether this body has been forced (by gameplay code) to be unfixed or not. This allows for the existing functionality and not having to change all of the existing code for setting fixed/unfixed on body instances. Useful for chopping off limbs and having Pawn go to ragdoll and back and still be able to play animations.

bInstanceAlwaysFullAnimWeight Source code

If this is true that all of the "updatetransform" data should come from the physics and not the anim data. NOTE: If an animation is played on the bones and there is no actual BodyInstance (e.g. ragdolls usually have finger and those indiv finger bones do not have a body instance on them) then the animation will still play as there is no body instance which is being checked for this override.

BodyData Source code

Internal use. Physics-engine representation of this body.

BodyIndex Source code

Index of this BodyInstance within the PhysicsAssetInstance/PhysicsAsset.

BoneSpring Source code

Internal use. Physics-engine representation of the spring on this body.

BoneSpringKinActor Source code

If bUseKinActorForBoneSpring is true, this is the Physics-engine representation of the kinematic actor the spring is attached to.

LastEffectPlayedTime Source code

For per-bodyinstance effects this keeps track of the last time one played. Could be used for items like gib effects.

OwnerComponent Source code

PrimitiveComponent containing this body. Due to the way the BodyInstance pooling works, this MUST BE FIRST PROPERTY OF THE CLASS.

PreviousVelocity Source code

Previous frame Velocity of this BodyInstance. Only updated if this is the root body of the CollisionComponent of an Actor in PHYS_RigidBody used for collision events since by the time the event is sent, Velocity would have been updated with the post-collision velocity

SceneIndex Source code

Physics scene index.

Velocity Source code

Current linear velocity of this BodyInstance. Only updated if this is the root body of the CollisionComponent of an Actor in PHYS_RigidBody

BoneSpring

bDisableOnOverextension Source code

If true, bone spring will automatically disable if it ever gets longer than the OverextensionThreshold.

bEnableBoneSpringAngular Source code

Enable angular 'spring' between the physics body for this bone, and the world-space location of the animation bone.

bEnableBoneSpringLinear Source code

Enable linear 'spring' between the physics body for this bone, and the world-space location of the animation bone.

bMakeSpringToBaseCollisionComponent Source code

When using bone springs, connect them to the physics body of the Base's CollisionComponent. When using this option, SetBoneSpringTarget must be given a matrix for this bone relative to the other bone, rather than relative to the world.

bNotifyOwnerOnOverextension Source code

Send notification to Owning Actor when overextended, by calling Actor::OnRigidBody

BoneAngularDamping Source code

Damping on angular spring to animated bone.

BoneAngularSpring Source code

Strength of angular spring to animated bone.

BoneLinearDamping Source code

Damping on linear spring to animated bone.

BoneLinearSpring Source code

Strength of linear spring to animated bone.

bTeleportOnOverextension Source code

This will teleport the whole PhysicsAssetInstance if this spring gets too long, to reduce to error to zero. Note - having this set on more than one body in a PhysicsAssetInstance will have unpredictable results.

bUseKinActorForBoneSpring Source code

When using bone springs, connect them to a kinematic body and animate that, rather than animating the attachment location on the 'world'. This adds some overhead, but tracks rapidly moving targets better.

OverextensionThreshold Source code

If bDisableOnOverextension is on, the bone spring will be disabled if it stretches more than this amount.

Physics

bEnableCollisionResponse Source code

Enables physics response for this body (on by default). If FALSE, contacts are still generated and reported. Useful for "sensor" bodies.

bOnlyCollideWithPawns Source code

This body should only collide with other bodies with their components marked bConsiderPawnForRBCollision. Useful for flappy bits you do not want to collide with the world.

bPushBody Source code

Denotes body as a "push" body. Also disables collision response, by definition.

ContactReportForceThreshold Source code

Used for force-based collision filtering. Note: this is NOT an additional filter on top of normal pairwise filtering. It is essentially a new kind of reporting. It can be used in conjuction with pairwise reporting, however. To disable this feature, set the threshold to a negative number.

InstanceDampingScale Source code

Per-instance scaling of linear/angular damping

InstanceMassScale Source code

Per-instance scaling of mass

PhysMaterialOverride Source code

Allows you to override the PhysicalMaterial to use for this body. Due to the way the BodyInstance pooling works, this MUST BE LAST PROPERTY OF THE CLASS.

RB_BodyInstance

CustomGravityFactor Source code

The force applied to the body to address custom gravity for the actor is multiplied CustomGravityFactor, allowing bodies to individually control how custom gravity settings affectthem

EnableBoneSpring Source code

Used to turn the angular/linear bone spring on and off. InBoneTarget is in world space, unless bMakeSpringToBaseCollisionComponent is TRUE, in which case it is relative to that body.

EnableCollisionResponse Source code

Enable/disable response to contacts.

GetBodyMass Source code

Returns the body's mass

GetPhysicsAssetInstance Source code

Returns the PhysicsAssetInstance that owns this RB_BodyInstance (if there is one)

GetUnrealWorldAngularVelocity Source code

Get current angular velocity in world space from physics body.

GetUnrealWorldTM Source code

Get current transform in world space from physics body.

GetUnrealWorldVelocity Source code

Get current velocity in world space from physics body.

GetUnrealWorldVelocityAtPoint Source code

Get current velocity of a point on this physics body, in world space. Point is specified in world space.

IsFixed Source code

Returns TRUE if this body is fixed

IsValidBodyInstance Source code

See if this body is valid.

SetBlockRigidBody Source code

Used to disable rigid body collisions for this body. Overrides the bNoCollision flag in the BodySetup for this body.

SetBoneSpringParams Source code

Used to set the spring stiffness and damping parameters for the bone spring.

SetBoneSpringTarget Source code

Used to set desired target location of this spring. Usually called by UpdateRBBonesFromSpaceBases. InBoneTarget is in world space, unless bMakeSpringToBaseCollisionComponent is TRUE, in which case it is relative to that body.

SetContactReportForceThreshold Source code

Set a new contact report force threhold. Threshold < 0 disables this feature.

SetFixed Source code

Force this body to be fixed (kinematic) or not. Overrides the BodySetup for this body.

SetPhysMaterialOverride Source code

Set physical material override for this body

UpdateDampingProperties Source code

Update instance's linear and angular damping

UpdateMassProperties Source code

Update instance's mass properties (mass, inertia and center-of-mass offset) based on MassScale, InstanceMassScale and COMNudge.

defaultproperties
{
	BoneLinearSpring=10.0
	BoneLinearDamping=0.1
	BoneAngularSpring=1.0
	BoneAngularDamping=0.1
	CustomGravityFactor=1.0
	LastEffectPlayedTime = 0.0
	bEnableCollisionResponse=TRUE
	ContactReportForceThreshold=-1.0f

	InstanceMassScale=1.0
	InstanceDampingScale=1.0
}