#include <Cylinder.h>

Inheritance diagram for Chaos::FCylinder:

Public Member Functions
	FCylinder (const FVec3 &x1, const FVec3 &x2, const FReal Radius)

	FCylinder (const FCylinder &Other)

	FCylinder (FCylinder &&Other)

	~FCylinder ()

TArray< FVec3 >	ComputeLocalSamplePoints (const int32 NumPoints, const bool IncludeEndCaps=true) const

TArray< FVec3 >	ComputeLocalSamplePoints (const FReal PointsPerUnitArea, const bool IncludeEndCaps=true, const int32 MinPoints=0, const int32 MaxPoints=1000) const

TArray< FVec3 >	ComputeSamplePoints (const int32 NumPoints, const bool IncludeEndCaps=true) const

TArray< FVec3 >	ComputeSamplePoints (const FReal PointsPerUnitArea, const bool IncludeEndCaps=true, const int32 MinPoints=0, const int32 MaxPoints=1000) const

virtual FReal	PhiWithNormal (const FVec3 &x, FVec3 &Normal) const override

virtual const FAABB3	BoundingBox () const override

virtual FReal	GetRadius () const override

FReal	GetHeight () const

const FVec3 &	GetX1 () const

const FVec3 &	GetX2 () const

const FVec3 &	GetOrigin () const

const FVec3 &	GetInsertion () const

FVec3	GetCenter () const

FVec3	GetCenterOfMass () const

FVec3	GetAxis () const

FReal	GetArea (const bool IncludeEndCaps=true) const

FReal	GetVolume () const

FMatrix33	GetInertiaTensor (const FReal Mass) const

FRotation3	GetRotationOfMass () const

virtual void	Serialize (FChaosArchive &Ar)

CHAOS_API FReal	SignedDistance (const FVec3 &x) const

virtual FName	GetTypeName () const

Public Member Functions inherited from Chaos::FImplicitObject
CHAOS_API	FImplicitObject (int32 Flags, EImplicitObjectType InType=ImplicitObjectType::Unknown)

	FImplicitObject (const FImplicitObject &)=delete

	FImplicitObject (FImplicitObject &&)=delete

virtual CHAOS_API	~FImplicitObject () override

template<typename TargetType >
bool	IsA () const

template<typename TargetType >
const TargetType *	AsA () const

template<typename TargetType >
TargetType *	AsA ()

template<typename TargetType >
const TargetType *	AsAChecked () const

template<typename TargetType >
TargetType *	AsAChecked ()

template<class T_DERIVED >
T_DERIVED *	GetObject ()

template<class T_DERIVED >
const T_DERIVED *	GetObject () const

template<class T_DERIVED >
const T_DERIVED &	GetObjectChecked () const

template<class T_DERIVED >
T_DERIVED &	GetObjectChecked ()

virtual EImplicitObjectType	GetNestedType () const

CHAOS_API EImplicitObjectType	GetType () const

CHAOS_API EImplicitObjectType	GetCollisionType () const

void	SetCollisionType (EImplicitObjectType InCollisionType)

virtual FRealSingle	GetRadiusf () const

virtual FReal	GetMargin () const

virtual FRealSingle	GetMarginf () const

virtual CHAOS_API bool	IsValidGeometry () const

virtual CHAOS_API Chaos::FImplicitObjectPtr	CopyGeometry () const

virtual CHAOS_API Chaos::FImplicitObjectPtr	CopyGeometryWithScale (const FVec3 &Scale) const

virtual Chaos::FImplicitObjectPtr	DeepCopyGeometry () const

virtual Chaos::FImplicitObjectPtr	DeepCopyGeometryWithScale (const FVec3 &Scale) const

virtual FImplicitObject *	Duplicate () const

virtual TUniquePtr< FImplicitObject >	Copy () const

virtual TUniquePtr< FImplicitObject >	CopyWithScale (const FVec3 &Scale) const

virtual TUniquePtr< FImplicitObject >	DeepCopy () const

virtual TUniquePtr< FImplicitObject >	DeepCopyWithScale (const FVec3 &Scale) const

CHAOS_API bool	IsUnderlyingUnion () const

CHAOS_API bool	IsUnderlyingMesh () const

CHAOS_API FReal	SignedDistance (const FVec3 &x) const

CHAOS_API FVec3	Normal (const FVec3 &x) const

virtual FReal	PhiWithNormalScaled (const FVec3 &Pos, const FVec3 &Scale, FVec3 &Normal) const

virtual FAABB3	CalculateTransformedBounds (const FRigidTransform3 &Transform) const

bool	HasBoundingBox () const

bool	IsConvex () const

void	SetConvex (const bool Convex=true)

void	SetDoCollide (const bool Collide)

bool	GetDoCollide () const

CHAOS_API void	Track (TSerializablePtr< FImplicitObject > This, const FString &DebugInfo)

virtual bool	IsPerformanceWarning () const

virtual FString	PerformanceWarningAndSimplifaction ()

CHAOS_API Pair< FVec3, bool >	FindDeepestIntersection (const FImplicitObject Other, const FBVHParticles Particles, const FMatrix33 &OtherToLocalTransform, const FReal Thickness) const

CHAOS_API Pair< FVec3, bool >	FindDeepestIntersection (const FImplicitObject Other, const FParticles Particles, const FMatrix33 &OtherToLocalTransform, const FReal Thickness) const

CHAOS_API Pair< FVec3, bool >	FindClosestIntersection (const FVec3 &StartPoint, const FVec3 &EndPoint, const FReal Thickness) const

virtual bool	Raycast (const FVec3 &StartPoint, const FVec3 &Dir, const FReal Length, const FReal Thickness, FReal &OutTime, FVec3 &OutPosition, FVec3 &OutNormal, int32 &OutFaceIndex) const

virtual int32	FindMostOpposingFace (const FVec3 &Position, const FVec3 &UnitDir, int32 HintFaceIndex, FReal SearchDist) const

virtual int32	FindMostOpposingFaceScaled (const FVec3 &Position, const FVec3 &UnitDir, int32 HintFaceIndex, FReal SearchDist, const FVec3 &Scale) const

virtual int32	FindClosestFaceAndVertices (const FVec3 &Position, TArray< FVec3 > &FaceVertices, FReal SearchDist=0.01f) const

virtual FVec3	FindGeometryOpposingNormal (const FVec3 &DenormDir, int32 FaceIndex, const FVec3 &OriginalNormal) const

virtual bool	Overlap (const FVec3 &Point, const FReal Thickness) const

virtual void	AccumulateAllImplicitObjects (TArray< Pair< const FImplicitObject *, FRigidTransform3 > > &Out, const FRigidTransform3 &ParentTM) const

virtual void	AccumulateAllSerializableImplicitObjects (TArray< Pair< TSerializablePtr< FImplicitObject >, FRigidTransform3 > > &Out, const FRigidTransform3 &ParentTM, TSerializablePtr< FImplicitObject > This) const

virtual CHAOS_API void	FindAllIntersectingObjects (TArray< Pair< const FImplicitObject *, FRigidTransform3 > > &Out, const FAABB3 &LocalBounds) const

virtual FString	ToString () const

CHAOS_API void	SerializeImp (FArchive &Ar)

virtual void	Serialize (FArchive &Ar)

virtual uint16	GetMaterialIndex (uint32 HintIndex) const

int32	CountObjectsInHierarchy () const

int32	CountLeafObjectsInHierarchy () const

void	VisitOverlappingLeafObjects (const FAABB3 &LocalBounds, const FImplicitHierarchyVisitor &Visitor) const

void	VisitLeafObjects (const FImplicitHierarchyVisitor &Visitor) const

void	VisitObjects (const FImplicitHierarchyVisitorBool &Visitor) const

bool	IsOverlappingBounds (const FAABB3 &LocalBounds) const

virtual int32	CountObjectsInHierarchyImpl () const

virtual int32	CountLeafObjectsInHierarchyImpl () const

virtual void	VisitOverlappingLeafObjectsImpl (const FAABB3 &LocalBounds, const FRigidTransform3 &ObjectTransform, const int32 RootObjectIndex, int32 &ObjectIndex, int32 &LeafObjectIndex, const FImplicitHierarchyVisitor &VisitorFunc) const

virtual void	VisitLeafObjectsImpl (const FRigidTransform3 &ObjectTransform, const int32 RootObjectIndex, int32 &ObjectIndex, int32 &LeafObjectIndex, const FImplicitHierarchyVisitor &VisitorFunc) const

virtual bool	VisitObjectsImpl (const FRigidTransform3 &ObjectTransform, const int32 RootObjectIndex, int32 &ObjectIndex, int32 &LeafObjectIndex, const FImplicitHierarchyVisitorBool &VisitorFunc) const

virtual bool	IsOverlappingBoundsImpl (const FAABB3 &LocalBounds) const

Public Member Functions inherited from Chaos::FChaosRefCountedObject
	FChaosRefCountedObject ()

virtual	~FChaosRefCountedObject ()

	FChaosRefCountedObject (const FChaosRefCountedObject &Rhs)=delete

FChaosRefCountedObject &	operator= (const FChaosRefCountedObject &Rhs)=delete

uint32	AddRef () const

uint32	Release () const

uint32	GetRefCount () const

void	MakePersistent () const

Static Public Member Functions
static constexpr EImplicitObjectType	StaticType ()

static FReal	GetArea (const FReal Height, const FReal Radius, const bool IncludeEndCaps)

static FReal	GetVolume (const FReal Height, const FReal Radius)

static FMatrix33	GetInertiaTensor (const FReal Mass, const FReal Height, const FReal Radius)

static FRotation3	GetRotationOfMass (const FVec3 &Axis)

static CHAOS_API const FName	GetTypeName (const EImplicitObjectType InType)

Static Public Member Functions inherited from Chaos::FImplicitObject
static CHAOS_API FImplicitObject *	SerializationFactory (FChaosArchive &Ar, FImplicitObject *Obj)

static int32	GetOffsetOfType ()

static int32	GetOffsetOfMargin ()

static constexpr EImplicitObjectType	StaticType ()

static CHAOS_API FArchive &	SerializeLegacyHelper (FArchive &Ar, TUniquePtr< FImplicitObject > &Value)

static CHAOS_API const FName	GetTypeName (const EImplicitObjectType InType)

Additional Inherited Members
Public Types inherited from Chaos::FImplicitObject
using	TType = FReal

Static Public Attributes inherited from Chaos::FImplicitObject
static constexpr int	D = 3

Protected Member Functions inherited from Chaos::FImplicitObject
void	SetMargin (FReal InMargin)

void	SetMargin (FRealSingle InMargin)

Static Protected Member Functions inherited from Chaos::FImplicitObject
static FVec3	ScaleNormalizedHelper (const FVec3 &Normal, const FVec3 &Scale)

static FVec3	GetOuterScaledNormal (const FVec3 &InnerNormal, const FVec3 &Scale)

static FVec3	GetInnerUnscaledNormal (const FVec3 &OuterNormal, const FVec3 &Scale)

Protected Attributes inherited from Chaos::FImplicitObject
FRealSingle	Margin

bool	bIsConvex

bool	bDoCollide

bool	bHasBoundingBox

bool	bIsTracked

EImplicitObjectType	Type

EImplicitObjectType	CollisionType

Constructor & Destructor Documentation

◆ FCylinder() [1/3]

Chaos::FCylinder::FCylinder	(	const FVec3 &	x1,
		const FVec3 &	x2,
		const FReal	Radius
	)

inline

◆ FCylinder() [2/3]

Chaos::FCylinder::FCylinder ( const FCylinder & Other )

inline

◆ FCylinder() [3/3]

Chaos::FCylinder::FCylinder ( FCylinder && Other )

inline

◆ ~FCylinder()

Chaos::FCylinder::~FCylinder ( )

inline

Member Function Documentation

◆ BoundingBox()

virtual const FAABB3 Chaos::FCylinder::BoundingBox ( ) const

inlineoverridevirtual

Reimplemented from Chaos::FImplicitObject.

◆ ComputeLocalSamplePoints() [1/2]

TArray< FVec3 > Chaos::FCylinder::ComputeLocalSamplePoints	(	const FReal	PointsPerUnitArea,
		const bool	IncludeEndCaps = `true`,
		const int32	MinPoints = `0`,
		const int32	MaxPoints = `1000`
	)		const

inline

Returns sample points centered about the origin.

PointsPerUnitArea specifies how many points to generate per square unit (cm). 0.5 would generate 1 point per 2 square cm. IncludeEndCaps determines whether or not points are generated on the end caps of the cylinder.

◆ ComputeLocalSamplePoints() [2/2]

FORCEINLINE TArray< FVec3 > Chaos::FCylinder::ComputeLocalSamplePoints	(	const int32	NumPoints,
		const bool	IncludeEndCaps = `true`
	)		const

Returns sample points centered about the origin.

NumPoints specifies how many points to generate. IncludeEndCaps determines whether or not points are generated on the end caps of the cylinder.

◆ ComputeSamplePoints() [1/2]

TArray< FVec3 > Chaos::FCylinder::ComputeSamplePoints	(	const FReal	PointsPerUnitArea,
		const bool	IncludeEndCaps = `true`,
		const int32	MinPoints = `0`,
		const int32	MaxPoints = `1000`
	)		const

inline

Returns sample points at the current location of the cylinder.

PointsPerUnitArea specifies how many points to generate per square unit (cm). 0.5 would generate 1 point per 2 square cm. IncludeEndCaps determines whether or not points are generated on the end caps of the cylinder.

◆ ComputeSamplePoints() [2/2]

FORCEINLINE TArray< FVec3 > Chaos::FCylinder::ComputeSamplePoints	(	const int32	NumPoints,
		const bool	IncludeEndCaps = `true`
	)		const

Returns sample points at the current location of the cylinder.

NumPoints specifies how many points to generate. IncludeEndCaps determines whether or not points are generated on the end caps of the cylinder.

◆ GetArea() [1/2]

FReal Chaos::FCylinder::GetArea ( const bool IncludeEndCaps = true ) const

inline

◆ GetArea() [2/2]

static FReal Chaos::FCylinder::GetArea	(	const FReal	Height,
		const FReal	Radius,
		const bool	IncludeEndCaps
	)

inlinestatic

◆ GetAxis()

FVec3 Chaos::FCylinder::GetAxis ( ) const

inline

◆ GetCenter()

FVec3 Chaos::FCylinder::GetCenter ( ) const

inline

◆ GetCenterOfMass()

FVec3 Chaos::FCylinder::GetCenterOfMass ( ) const

inline

Returns the centroid (center of mass).

◆ GetHeight()

FReal Chaos::FCylinder::GetHeight ( ) const

inline

◆ GetInertiaTensor() [1/2]

FMatrix33 Chaos::FCylinder::GetInertiaTensor ( const FReal Mass ) const

inline

◆ GetInertiaTensor() [2/2]

static FMatrix33 Chaos::FCylinder::GetInertiaTensor	(	const FReal	Mass,
		const FReal	Height,
		const FReal	Radius
	)

inlinestatic

◆ GetInsertion()

const FVec3 & Chaos::FCylinder::GetInsertion ( ) const

inline

Returns the topmost point on the cylinder.

◆ GetOrigin()

const FVec3 & Chaos::FCylinder::GetOrigin ( ) const

inline

Returns the bottommost point on the cylinder.

◆ GetRadius()

virtual FReal Chaos::FCylinder::GetRadius ( ) const

inlineoverridevirtual

Reimplemented from Chaos::FImplicitObject.

◆ GetRotationOfMass() [1/2]

FRotation3 Chaos::FCylinder::GetRotationOfMass ( ) const

inline

◆ GetRotationOfMass() [2/2]

static FRotation3 Chaos::FCylinder::GetRotationOfMass ( const FVec3 & Axis )

inlinestatic

◆ GetTypeName() [1/2]

virtual FName Chaos::FImplicitObject::GetTypeName ( ) const

inlinevirtual

Reimplemented from Chaos::FImplicitObject.

◆ GetTypeName() [2/2]

const FName Chaos::FImplicitObject::GetTypeName ( const EImplicitObjectType InType )

static

◆ GetVolume() [1/2]

FReal Chaos::FCylinder::GetVolume ( ) const

inline

◆ GetVolume() [2/2]

static FReal Chaos::FCylinder::GetVolume	(	const FReal	Height,
		const FReal	Radius
	)

inlinestatic

◆ GetX1()

const FVec3 & Chaos::FCylinder::GetX1 ( ) const

inline

◆ GetX2()

const FVec3 & Chaos::FCylinder::GetX2 ( ) const

inline

◆ PhiWithNormal()

virtual FReal Chaos::FCylinder::PhiWithNormal	(	const FVec3 &	x,
		FVec3 &	Normal
	)		const

inlineoverridevirtual

Implements Chaos::FImplicitObject.

◆ Serialize()

virtual void Chaos::FCylinder::Serialize ( FChaosArchive & Ar )

inlinevirtual

Reimplemented from Chaos::FImplicitObject.

◆ SignedDistance()

FReal Chaos::FImplicitObject::SignedDistance ( const FVec3 & x ) const

◆ StaticType()

static constexpr EImplicitObjectType Chaos::FCylinder::StaticType ( )

inlinestaticconstexpr

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

Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/Cylinder.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ FCylinder() [1/3]

◆ FCylinder() [2/3]

◆ FCylinder() [3/3]

◆ ~FCylinder()

Member Function Documentation

◆ BoundingBox()

◆ ComputeLocalSamplePoints() [1/2]

◆ ComputeLocalSamplePoints() [2/2]

◆ ComputeSamplePoints() [1/2]

◆ ComputeSamplePoints() [2/2]

◆ GetArea() [1/2]

◆ GetArea() [2/2]

◆ GetAxis()

◆ GetCenter()

◆ GetCenterOfMass()

◆ GetHeight()

◆ GetInertiaTensor() [1/2]

◆ GetInertiaTensor() [2/2]

◆ GetInsertion()

◆ GetOrigin()

◆ GetRadius()

◆ GetRotationOfMass() [1/2]

◆ GetRotationOfMass() [2/2]

◆ GetTypeName() [1/2]

◆ GetTypeName() [2/2]

◆ GetVolume() [1/2]

◆ GetVolume() [2/2]

◆ GetX1()

◆ GetX2()

◆ PhiWithNormal()

◆ Serialize()

◆ SignedDistance()

◆ StaticType()