Engine.PrimitiveComponent

Extends

ActorComponent

Modifiers

dependson ( Scene ) native noexport abstract

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

Core.Object
|   
+-- Core.Component
   |   
   +-- Engine.ActorComponent
      |   
      +-- Engine.PrimitiveComponent

Direct Known Subclasses:

ArrowComponent, BrushComponent, CameraConeComponent, CascadePreviewComponent, CoverGroupRenderingComponent, CylinderComponent, DecalComponent, DrawBoxComponent, DrawCapsuleComponent, DrawConeComponent, DrawCylinderComponent, DrawFrustumComponent, DrawQuadComponent, DrawSphereComponent, EditorComponent, FoliageComponent, LensFlareComponent, LensFlarePreviewComponent, LineBatchComponent, MeshComponent, ModelComponent, ParticleSystemComponent, PathRenderingComponent, RB_ConstraintDrawComponent, RB_RadialImpulseComponent, RouteRenderingComponent, SpeedTreeComponent, SpriteComponent, TerrainComponent

Functions Summary
		AddForce (vector Force, optional vector Position, optional name BoneName)
		AddImpulse (vector Impulse, optional vector Position, optional name BoneName, optional bool bVelChange)
		AddRadialForce (vector Origin, float Radius, float Strength, ERadialImpulseFalloff Falloff)
		AddRadialImpulse (vector Origin, float Radius, float Strength, ERadialImpulseFalloff Falloff, optional bool bVelChange)
	vector	GetPosition ()))
	RB_BodyInstance	GetRootBodyInstance ()
		PutRigidBodyToSleep (optional name BoneName)
	bool	RigidBodyIsAwake (optional name BoneName)
		SetAbsolute (optional bool NewAbsoluteTranslation, ptional bool NewAbsoluteRotation, ptional bool NewAbsoluteScale)
		SetActorCollision (bool NewCollideActors, bool NewBlockActors)
		SetBlockRigidBody (bool bNewBlockRigidBody)
		SetCullDistance (float NewCullDistance)
		SetDepthPriorityGroup (ESceneDepthPriorityGroup NewDepthPriorityGroup)
		SetHidden (bool NewHidden)
		SetIgnoreOwnerHidden (bool bNewIgnoreOwnerHidden)
		SetLightEnvironment (LightEnvironmentComponent NewLightEnvironment)
		SetLightingChannels (LightingChannelContainer NewLightingChannels)
		SetNotifyRigidBodyCollision (bool bNewNotifyRigidBodyCollision)
		SetOnlyOwnerSee (bool bNewOnlyOwnerSee)
		SetOwnerNoSee (bool bNewOwnerNoSee)
		SetPhysMaterialOverride (PhysicalMaterial NewPhysMaterial)
		SetRBAngularVelocity (vector NewAngVel, optional bool bAddToCurrent)
		SetRBChannel (ERBCollisionChannel Channel)
		SetRBCollidesWithChannel (ERBCollisionChannel Channel, bool bNewCollides)
		SetRBDominanceGroup (BYTE InDomGroup)
		SetRBLinearVelocity (vector NewVel, optional bool bAddToCurrent)
		SetRBPosition (vector NewPos, optional name BoneName)
		SetRBRotation (rotator NewRot, optional name BoneName)
		SetRotation (rotator NewRotation)
		SetScale (float NewScale)
		SetScale3D (vector NewScale3D)
		SetShadowParent (PrimitiveComponent NewShadowParent)
		SetTraceBlocking (bool NewBlockZeroExtent, bool NewBlockNonZeroExtent)
		SetTranslation (vector NewTranslation)
		SetViewOwnerDepthPriorityGroup (bool bNewUseViewOwnerDepthPriorityGroup, ESceneDepthPriorityGroup NewViewOwnerDepthPriorityGroup)
		WakeRigidBody (optional name BoneName)

AlwaysLoadOnClient Source code

If this is True, this component must always be loaded on clients, even if HiddenGame && !CollideActors.

AlwaysLoadOnServer Source code

If this is True, this component must always be loaded on servers, even if !CollideActors.

bIsRefreshingDecals Source code

BlockActors Source code

BlockNonZeroExtent Source code

BlockZeroExtent Source code

BodyInstance Source code

Bounds Source code

bUseViewOwnerDepthPriorityGroup Source code

True if the primitive should be rendered using ViewOwnerDepthPriorityGroup if viewed by its owner.

bWasSNFiltered Source code

CachedParentToWorld Source code

CollideActors Source code

DecalList Source code

DetachFence Source code

A fence to track when the primitive is detached from the scene in the rendering thread.

FogVolumeComponent Source code

Keeps track of which fog component this primitive is using.

LastRenderTime Source code

The value of WorldInfo->TimeSeconds for the frame when this actor was last rendered. This is written from the render thread, which is up to a frame behind the game thread, so you should allow this time to be at least a frame behind the game thread's world time before you consider the actor non-visible. There's an equivalent variable in PrimitiveComponent.

LastSubmitTime Source code

Last time the component was submitted for rendering (called FScene::AddPrimitive).

LightEnvironment Source code

The lighting environment to take the primitive's lighting from.

LocalToWorld Source code

LocalToWorldDeterminant Source code

MotionBlurInfoIndex Source code

The index for the primitive component in the MotionBlurInfo array of the scene. Render-thread usage only. This assumes that there is only one scene that requires motion blur, as there is only a single index... If the application requires a primitive component to exist in multiple scenes and have motion blur in each of them, this can be changed into a mapping of the scene pointer to the index. (Associated functions would have to be updated as well...)

OctreeNodes Source code

RigidBodyIgnorePawns Source code

DEPRECATED! Use RBChannel/RBCollideWithChannels instead now

SceneInfo Source code

The primitive's scene info.

ScriptRigidBodyCollisionThreshold Source code

if > 0, the script RigidBodyCollision() event will be called on our Owner when a physics collision involving this PrimitiveComponent occurs and the relative velocity is greater than or equal to this

ShadowParent Source code

Tag Source code

ViewOwnerDepthPriorityGroup Source code

The scene depth priority group to draw the primitive in, if it's being viewed by its owner.

Collision

BlockRigidBody Source code

RBChannel Source code

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

RBCollideWithChannels Source code

Types of objects that this physics objects will collide with.

Lighting

bAcceptsDynamicLights Source code

Whether this primitives accepts dynamic lights controls whether the object should be affected by dynamic lights.

bAcceptsLights Source code

Does this primitive accept lights? controls whether the primitive accepts any lights. Should be set to FALSE for e.g. unlit objects as its a nice optimization - especially for larger objects.

bCastDynamicShadow Source code

If false, primitive does not cast dynamic shadows. controls whether the primitive should cast shadows in the case of non precomputed shadowing like e.g. the primitive being in between a light and a dynamic object. This flag is only used if CastShadow is TRUE. Currently dynamic primitives will not receive shadows from static objects unless both this flag and CastShadow are enabled.

bCastHiddenShadow Source code

If TRUE, the primitive will cast shadows even if bHidden is TRUE. Controls whether the primitive should cast shadows when hidden. This flag is only used if CastShadow is TRUE.

bForceDirectLightMap Source code

If true, forces all static lights to use light-maps for direct lighting on this primitive, regardless of the light's UseDirectLightMap property. forces the use of lightmaps for all static lights affecting this primitive even though the light might not be set to use light maps. This means that the primitive will not receive any shadows from dynamic objects obstructing static lights. It will correctly shadow in the case of dynamic lights

bUsePrecomputedShadows Source code

Whether the primitive supports/ allows static shadowing

CastShadow Source code

Whether to cast any shadows or not controls whether the primitive component should cast a shadow or not. Currently dynamic primitives will not receive shadows from static objects unless both this flag and bCastDynamicSahdow are enabled.

LightingChannels Source code

Lighting channels controlling light/ primitive interaction. Only allows interaction if at least one channel is shared

Physics

bDisableAllRigidBody Source code

Never create any physics engine representation for this body.

bFluidDrain Source code

Whether this object should act as a 'drain' for fluid, and destroy fluid particles when they contact it.

bFluidTwoWay Source code

Indicates that fluid interaction with this object should be 'two-way' - that is, force should be applied to both fluid and object.

bIgnoreForceField Source code

Will ignore force field applied to this component.

bIgnoreRadialForce Source code

Will ignore radial forces applied to this component.

bIgnoreRadialImpulse Source code

Will ignore radial impulses applied to this component.

bNotifyRigidBodyCollision Source code

Flag that indicates if OnRigidBodyCollision function should be called for physics collisions involving this PrimitiveComponent.

bUseCompartment Source code

Place into a NxCompartment that will run in parallel with the primary scene's physics with potentially different simulation parameters.

PhysMaterialOverride Source code

Allows you to override the PhysicalMaterial to use for this PrimitiveComponent.

RBDominanceGroup Source code

Used for creating one-way physics interactions (via constraints or contacts) Groups with lower RBDominanceGroup push around higher values in a 'one way' fashion. Must be <32.

PrimitiveComponent

AbsoluteRotation Source code

AbsoluteScale Source code

AbsoluteTranslation Source code

bIgnoreHiddenActorsMembership Source code

@fixme JF, Hack for gears ship to allow certain components to render even if the parent actor is part of the camera's HiddenActors array. Potentially worth cleaning up and integrating back to mainline, but I'm not really caring about that right now. :)

Rotation Source code

Scale Source code

Scale3D Source code

Translation Source code

Rendering

bAcceptsDecals Source code

If TRUE, this primitive accepts decals.

bAcceptsDecalsDuringGameplay Source code

If TRUE, this primitive accepts decals spawned during gameplay. Effectively FALSE if bAcceptsDecals is FALSE.

bAcceptsFoliage Source code

If TRUE, this primitive accepts foliage.

bAllowApproximateOcclusion Source code

If this is True, this component doesn't need exact occlusion info.

bAllowCullDistanceVolume Source code

Whether to accept cull distance volumes to modify cached cull distance.

bForceMipStreaming Source code

If TRUE, forces mips for textures used by this component to be resident when this component's level is loaded.

bIgnoreOwnerHidden Source code

If true, bHidden on the Owner of this component will be ignored.

bOnlyOwnerSee Source code

If this is True, this component will only be visible when the view actor is the component's owner, directly or indirectly.

bOwnerNoSee Source code

If this is True, this component won't be visible when the view actor is the component's owner, directly or indirectly.

bUseAsOccluder Source code

If this is True, this primitive will be used to occlusion cull other primitives.

CachedCullDistance Source code

The distance to cull this primitive at. A CullDistance of 0 indicates that the primitive should not be culled by distance. The distance calculation uses the center of the primitive's bounding sphere.

CullDistance Source code

Cull distance exposed to LDs. The real cull distance is the min (disregarding 0) of this and volumes affecting this object.

DepthPriorityGroup Source code

The scene depth priority group to draw the primitive in.

DetailMode Source code

If detail mode is >= system detail mode, primitive won't be rendered.

HiddenEditor Source code

HiddenGame Source code

MotionBlurScale Source code

Scalar controlling the amount of motion blur to be applied when object moves

TranslucencySortPriority Source code

Translucent objects with a lower sort priority draw before objects with a higher priority. Translucent objects with the same priority are rendered from back-to-front based on their bounds origin. Ignored if the object is not translucent. The default priority is zero.

ERadialImpulseFalloff Source code

Enum for controlling the falloff of strength of a radial impulse as a function of distance from Origin.

ERBCollisionChannel Source code

Enum indicating different type of objects for rigid-body collision purposes.

MaterialViewRelevance Source code

Mirrored from Scene.h

RBCollisionChannelContainer Source code

Container for indicating a set of collision channel that this object will collide with. Mirrored manually in UnPhysPublic.h

AddForce Source code

Add a force to this component.
@param Force Force vector to apply. Magnitude indicates strength of force.
@param Position Position on object to apply force. If (0,0,0), force is applied at center of mass.
@param BoneName Used in the skeletal case to apply a force to a single body.

AddImpulse Source code

Add an impulse to the physics of this PrimitiveComponent.
@param Impulse Magnitude and direction of impulse to apply.
@param Position Point in world space to apply impulse at. If Position is (0,0,0), impulse is applied at center of mass ie. no rotation.
@param BoneName If a SkeletalMeshComponent, name of bone to apply impulse to.
@param bVelChange If true, the Strength is taken as a change in velocity instead of an impulse (ie. mass will have no affect).

AddRadialForce Source code

Add a force originating from the supplied world-space location.
@param Origin Origin of force in world space.
@param Radius Radius within which to apply the force.
@param Strength Strength of force to apply.
@param Falloff Allows you to control the strength of the force as a function of distance from Origin.

AddRadialImpulse Source code

Add an impulse to this component, radiating out from the specified position. In the case of a skeletal mesh, may affect each bone of the mesh.
@param Origin Point of origin for the radial impulse blast
@param Radius Size of radial impulse. Beyond this distance from Origin, there will be no affect.
@param Strength Maximum strength of impulse applied to body.
@param Falloff Allows you to control the strength of the impulse as a function of distance from Origin.
@param bVelChange If true, the Strength is taken as a change in velocity instead of an impulse (ie. mass will have no affect).

GetPosition Source code

GetRootBodyInstance Source code

returns the physics RB_BodyInstance for the root body of this component (if any)

PutRigidBodyToSleep Source code

Put a simulation back to see.

RigidBodyIsAwake Source code

Returns if the body is currently awake and simulating. If a SkeletalMeshComponent, and no BoneName is specified, will pick a random bone - so does not make much sense if not all bones are jointed together.

SetAbsolute Source code

SetActorCollision Source code

SetBlockRigidBody Source code

Change the value of BlockRigidBody.
@param NewBlockRigidBody - The value to assign to BlockRigidBody.

SetCullDistance Source code

Changes the value of CullDistance.
@param NewCullDistance - The value to assign to CullDistance.

SetDepthPriorityGroup Source code

Changes the value of DepthPriorityGroup.
@param NewDepthPriorityGroup - The value to assign to DepthPriorityGroup.

SetHidden Source code

Changes the value of HiddenGame.
@param NewHidden - The value to assign to HiddenGame.

SetIgnoreOwnerHidden Source code

Changes the value of bIgnoreOwnerHidden.

SetLightEnvironment Source code

Changes the value of LightEnvironment.
@param NewLightEnvironment - The value to assign to LightEnvironment.

SetLightingChannels Source code

Changes the value of LightingChannels.
@param NewLightingChannels - The value to assign to LightingChannels.

SetNotifyRigidBodyCollision Source code

Changes the value of bNotifyRigidBodyCollision
@param bNewNotifyRigidBodyCollision - The value to assign to bNotifyRigidBodyCollision

SetOnlyOwnerSee Source code

Changes the value of bOnlyOwnerSee.

SetOwnerNoSee Source code

Changes the value of bOwnerNoSee.

SetPhysMaterialOverride Source code

Changes the current PhysMaterialOverride for this component. Note that if physics is already running on this component, this will _not_ alter its mass/inertia etc, it will only change its surface properties like friction and the damping.

SetRBAngularVelocity Source code

Set the angular velocity of the rigid body physics of this PrimitiveComponent. If no rigid-body physics is active, will do nothing. In the case of a SkeletalMeshComponent will affect all bones - and will apply the linear velocity necessary to get all bones to rotate around the root. This should be used cautiously - it may be better to use AddForce or AddImpulse.
@param NewAngVel New angular velocity to apply to physics.
@param bAddToCurrent If true, NewAngVel is added to the existing velocity of the body.

SetRBChannel Source code

Changes the rigid-body channel that this object is defined in.

SetRBCollidesWithChannel Source code

Changes a member of the RBCollideWithChannels container for this PrimitiveComponent.
@param bNewCollides whether or not to collide with passed in channel

SetRBDominanceGroup Source code

Used for creating one-way physics interactions. @see RBDominanceGroup

SetRBLinearVelocity Source code

Set the linear velocity of the rigid body physics of this PrimitiveComponent. If no rigid-body physics is active, will do nothing. In the case of a SkeletalMeshComponent will affect all bones. This should be used cautiously - it may be better to use AddForce or AddImpulse.
@param NewVel New linear velocity to apply to physics.
@param bAddToCurrent If true, NewVel is added to the existing velocity of the body.

SetRBPosition Source code

Called if you want to move the physics of a component which has dynamics running (ie actor is in PHYS_RigidBody). Be careful calling this when this is jointed to something else, or when it does not fit in the destination (no checking is done).
@param NewPos new position of the body
@param BoneName (SkeletalMeshComponent only) if specified, the bone to change position of if not specified for a SkeletalMeshComponent, all bodies are moved by the delta between the desired location and that of the root body.

SetRBRotation Source code

Called if you want to rotate the physics of a component which has dynamics running (ie actor is in PHYS_RigidBody).
@param NewRot new rotation of the body
@param BoneName (SkeletalMeshComponent only) if specified, the bone to change rotation of if not specified for a SkeletalMeshComponent, all bodies are moved by the delta between the desired rotation and that of the root body.

SetRotation Source code

SetScale Source code

SetScale3D Source code

SetShadowParent Source code

Changes the value of ShadowParent.
@param NewShadowParent - The value to assign to ShadowParent.

SetTraceBlocking Source code

SetTranslation Source code

SetViewOwnerDepthPriorityGroup Source code

Changes the value of bUseViewOwnerDepthPriorityGroup and ViewOwnerDepthPriorityGroup.
@param bNewUseViewOwnerDepthPriorityGroup - The value to assign to bUseViewOwnerDepthPriorityGroup.
@param NewViewOwnerDepthPriorityGroup - The value to assign to ViewOwnerDepthPriorityGroup.

WakeRigidBody Source code

Ensure simulation is running for this component. If a SkeletalMeshComponent and no BoneName is specified, will wake all bones in the PhysicsAsset.

defaultproperties
{
   DepthPriorityGroup=SDPG_World
   MotionBlurScale=1.000000
   bAllowCullDistanceVolume=True
   bAcceptsDecalsDuringGameplay=True
   bAcceptsFoliage=True
   bCastDynamicShadow=True
   bAcceptsDynamicLights=True
   AlwaysLoadOnClient=True
   AlwaysLoadOnServer=True
   RBDominanceGroup=15
   Scale=1.000000
   Scale3D=(X=1.000000,Y=1.000000,Z=1.000000)
   Name="Default__PrimitiveComponent"
   ObjectArchetype=ActorComponent'Engine.Default__ActorComponent'
}