FOctreeNodeContext

The context of an octree node, derived from the traversal of the tree.

Windows
MacOS
Linux

Syntax

class FOctreeNodeContext

Remarks

The context of an octree node, derived from the traversal of the tree.

Variables

Name Description

Public variable

FBoxCenterAndEx...

 

Bounds

The bounds of the node.

Public variable

float

 

ChildCenterOffset

The offset of the childrens' centers from the center of this node.

Public variable

float

 

ChildExtent

The extent of the node's children.

Public variable

uint32

 

InCullBits

Bits used for culling, semantics left up to the caller (except that it is always set to zero at the root).

Public variable

uint32

 

OutCullBits

Bits used for culling, semantics left up to the caller (except that it is always set to zero at the root).

Constructors

Name Description

Public function

FOctreeNodeContext()

Default constructor.

Public function

FOctreeNodeContext

(
    const FBoxCenterAndExtent& InBound...
)

Initialization constructor.

Public function

FOctreeNodeContext

(
    uint32 InInCullBits,
    uint32 InOutCullBits
)

Initialization constructor, this one is used when we done care about the box anymore

Public function

FOctreeNodeContext

(
    const FBoxCenterAndExtent& InBound...,
    uint32 InInCullBits,
    uint32 InOutCullBits
)

Initialization constructor.

Functions

Name Description

Public function Const

FOctreeNodeC...

 

GetChildContext

(
    FOctreeChildNodeRef ChildRef
)

Child node initialization constructor.

Public function Const

void

 

GetChildContext

(
    FOctreeChildNodeRef ChildRef,
    FOctreeNodeContext*__restrict ...
)

Construct a child context given the child ref. Optimized to remove all LHS.

Public function Const

FOctreeNodeC...

 

GetChildContext

(
    FOctreeChildNodeRef ChildRef,
    uint32 InInCullBits,
    uint32 InOutCullBits
)

Child node initialization constructor.

Public function Const

FOctreeChild...

 

GetContainingChild

(
    const FBoxCenterAndExtent& Boundin...
)

Determines which of the octree node's children contain the whole bounding box, if any.

Public function Const

FOctreeChild...

 

GetIntersectingChildren

(
    const FBoxCenterAndExtent& Boundin...
)

Determines which of the octree node's children intersect with a bounding box.

Constants

Name

Description

LoosenessDenominator

The node bounds are expanded by their extent divided by LoosenessDenominator.

References

Module

Engine

Header

Runtime/Engine/Public/GenericOctree.h

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback