#include <PrimitiveComponent.h>

Inheritance diagram for Karma::UPrimitiveComponent:

[legend]

Collaboration diagram for Karma::UPrimitiveComponent:

[legend]

Public Member Functions
virtual void	BeginPlay () override

void	SetCachedMaxDrawDistance (const float newCachedMaxDrawDistance)

Public Member Functions inherited from Karma::USceneComponent
const glm::vec3 &	GetRelativeRotation () const

const glm::vec3 &	GetRelativeLocation () const

const glm::vec3 &	GetRelativeScale3D () const

void	SetWorldLocation (glm::vec3 newLocation)

void	SetWorldTransform (const FTransform &NewTransform)

std::shared_ptr< USceneComponent >	GetAttachParent () const

virtual FTransform	GetSocketTransform (const std::string &InSocketName, ERelativeTransformSpace TransformSpace=RTS_World) const

const FTransform &	GetComponentTransform () const

virtual void	BeginDestroy () override
	Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

bool	IsUsingAbsoluteLocation () const

bool	IsUsingAbsoluteRotation () const

bool	IsUsingAbsoluteScale () const

void	SetRelativeTransform (const FTransform &NewTransform)

FORCEINLINE const std::string &	GetAttachSocketName () const

Public Member Functions inherited from Karma::UActorComponent
virtual void	TickComponent (float deltaTime)

virtual void	EndPlay (const EEndPlayReason::Type EndPlayReason)

AActor *	GetOwner () const

bool	HasBeenCreated () const

virtual void	OnComponentCreated ()

bool	IsRegistered () const

bool	IsActive () const

virtual void	Activate (bool bReset=false)

void	SetActiveFlag (const bool bNewIsActive)

bool	HasBeenInitialized () const

virtual void	InitializeComponent ()

bool	HasBegunPlay () const

virtual void	UninitializeComponent ()

virtual void	OnComponentDestroyed (bool bDestroyingHierarchy)

Public Member Functions inherited from Karma::UObject
	UObject ()

virtual void	FinishDestroy ()

virtual const std::string &	GetDesc ()
	Return a one line description of an object for viewing in the thumbnail view of the generic browser.

virtual class UWorld *	GetWorld () const
	Returns what UWorld this object is contained within.

bool	IsValidChecked (const UObject *Test)

FORCEINLINE bool	Modify (bool bAlwaysMarkDirty=true)

bool	IsSelected () const
	Test the selection state of a UObject.

Public Member Functions inherited from Karma::UObjectBase
	UObjectBase (UClass inClass, EObjectFlags inFlags, EInternalObjectFlags inInternalFlags, UObject inOuter, const std::string &inName)

UPackage *	GetPackage () const

UPackage *	GetExternalPackage () const

bool	IsUnreachable () const

FORCEINLINE void	SetInternalIndex (uint32_t StoreIndex)

FORCEINLINE uint32_t	GetInterIndex () const

void	MarkAsGarbage ()

void	ClearGarbage ()

FORCEINLINE const std::string &	GetName () const

FORCEINLINE void	SetObjectName (const std::string &aName)

FORCEINLINE UObject *	GetOuter () const

UObject *	GetTypedOuter (UClass *Target) const

template<typename T >
T *	GetTypedOuter () const

bool	IsValidLowLevel () const

template<typename OtherClassType >
FORCEINLINE bool	IsA (OtherClassType SomeBase) const

FORCEINLINE UClass *	GetClass () const

FORCEINLINE EObjectFlags	GetFlags () const

FORCEINLINE void	SetFlags (EObjectFlags NewFlags)

FORCEINLINE void	ClearFlags (EObjectFlags NewFlags)

FORCEINLINE bool	HasAnyFlags (EObjectFlags FlagsToCheck) const

FORCEINLINE bool	HasAnyInternalFlags (EInternalObjectFlags FlagsToCheck) const

FORCEINLINE void	SetInternalFlags (EInternalObjectFlags FlagsToSet) const

FORCEINLINE void	AddToRoot ()

Public Attributes
uint8_t	CastShadow: 1

Public Attributes inherited from Karma::USceneComponent
glm::vec3	m_ComponentVelocity

std::string	m_AttachSocketName

std::vector< std::shared_ptr< USceneComponent > >	m_AttachChildren

Public Attributes inherited from Karma::UActorComponent
EComponentCreationMethod	m_CreationMethod

uint8_t	m_bAutoActivate: 1

uint8_t	m_bWantsInitializeComponent: 1

Additional Inherited Members
Static Public Member Functions inherited from Karma::UObject
static const char *	StaticConfigName ()

Static Public Member Functions inherited from Karma::UObjectBase
static FORCEINLINE EInternalObjectFlags	FixGarbageOrPendingKillInternalObjectFlags (const EInternalObjectFlags InFlags)

Protected Member Functions inherited from Karma::UActorComponent
virtual bool	ShouldActivate () const

Protected Member Functions inherited from Karma::UObjectBase
FORCEINLINE void	SetFlagsTo (EObjectFlags NewFlags)

Protected Attributes inherited from Karma::UActorComponent
uint8_t	m_bRegistered: 1

Detailed Description

PrimitiveComponents are SceneComponents that contain or generate some sort of geometry, generally to be rendered or used as collision data. There are several subclasses for the various types of geometry, but the most common by far are the ShapeComponents (Capsule, Sphere, Box), StaticMeshComponent, and SkeletalMeshComponent. ShapeComponents generate geometry that is used for collision detection but are not rendered, while StaticMeshComponents and SkeletalMeshComponents contain pre-built geometry that is rendered, but can also be used for collision detection.

Member Function Documentation

◆ BeginPlay()

void Karma::UPrimitiveComponent::BeginPlay ( )

overridevirtual

Used to detach physics objects before simulation begins. This is needed because at runtime we can't have simulated objects inside the attachment hierarchy

Reimplemented from Karma::UActorComponent.

◆ SetCachedMaxDrawDistance()

void Karma::UPrimitiveComponent::SetCachedMaxDrawDistance ( const float newCachedMaxDrawDistance )

Utility to cache the max draw distance based on cull distance volumes or the desired max draw distance

Member Data Documentation

◆ CastShadow

uint8_t Karma::UPrimitiveComponent::CastShadow

Controls whether the primitive component should cast a shadow or not.

The documentation for this class was generated from the following files:

Karma/src/Karma/GameFramework/PrimitiveComponent.h
Karma/src/Karma/GameFramework/PrimitiveComponent.cpp

Public Member Functions