Api Sandbox SceneCullingBox
class

SceneCullingBox

public sealed class SceneCullingBox

A box which can be used to explicitly control scene visibility. There are two modes: 1. Cull inside, hide any objects fully inside the box (excluder) 2. Cull outside, hide any objects not intersecting any cull boxes marked cull outside (includer)

Constructors

SceneCullingBox(SceneWorld world, Transform transform, Vector3 size, CullMode mode)

Create a scene culling box. Each scene world can have a list of boxes which can be used to explicitly cull objects inside or outside the boxes.

Properties

Name Type Description
IsValid virtual Boolean Is this culling box valid, exists inside a scene world.
World SceneWorld The scene world this culling box belongs to.
Transform Transform Position and rotation of this box, scale will scale the box size
Size Vector3 Size of this box, transform scale will scale this size
Mode CullMode Cull mode, either inside or outside

Methods

Void Delete()

Delete this culling box. You shouldn't access it anymore.

Assembly: Sandbox.Engine Namespace: Sandbox Full Name: Sandbox.SceneCullingBox