s&box docs
API Referenceglobal

SceneSettingsclass

object→SceneSettings
Namespace
global
Assembly
Sandbox.Engine
Declaration
public class Sandbox.Gizmo.SceneSettings

Constructors1

Showing 1 constructors

Methods3

Showing 3 methods

public void ClearEnabledGizmos()PUBLIC

Clear all enabled gizmos

Returns:void—

public bool IsGizmoEnabled(System.Type type)PUBLIC

Check if a gizmo type is enabled

ParameterTypeDescription
typeType—
Returns:bool—

public void SetGizmoEnabled(System.Type type, bool enabled)PUBLIC

Set the enabled state of a gizmo type

ParameterTypeDescription
typeType—
enabledbool—
Returns:void—

Properties14

Showing 14 properties

public float Sandbox.Gizmo.SceneSettings.AngleSpacing { get; set; }PUBLICGETSET

Grid spacing

Returns:float—

public bool Sandbox.Gizmo.SceneSettings.DebugActionGraphs { get; set; }PUBLICGETSET

Should we show lines representing GameObject references in action graphs?

Returns:bool—

public string Sandbox.Gizmo.SceneSettings.EditMode { get; set; }PUBLICGETSET

How do we want to edit this? Usually something like "position", "rotation", "scale" etc

Returns:string—

public bool Sandbox.Gizmo.SceneSettings.GizmoDepthTest { get; set; }PUBLICGETSET

When enabled, component gizmo handles are depth tested against scene geometry. When disabled, they render on top of everything.

Returns:bool—

public float Sandbox.Gizmo.SceneSettings.GizmoRenderDistance { get; set; }PUBLICGETSET

Maximum distance from the camera at which component gizmo handles are visible. Set to 0 for unlimited distance.

Returns:float—

public float Sandbox.Gizmo.SceneSettings.GizmoScale { get; set; }PUBLICGETSET

How big to show the gizmos

Returns:float—

public bool Sandbox.Gizmo.SceneSettings.GizmosEnabled { get; set; }PUBLICGETSET

Are gizmos enabled?

Returns:bool—

public bool Sandbox.Gizmo.SceneSettings.GlobalSpace { get; set; }PUBLICGETSET

Editing in local space

Returns:bool—

public float Sandbox.Gizmo.SceneSettings.GridSpacing { get; set; }PUBLICGETSET

Grid spacing

Returns:float—

public bool Sandbox.Gizmo.SceneSettings.Selection { get; set; }PUBLICGETSET

Do we want to let the user select things in the current mode?

Returns:bool—

public bool Sandbox.Gizmo.SceneSettings.SnapToAngles { get; set; }PUBLICGETSET

Snap angles

Returns:bool—

public bool Sandbox.Gizmo.SceneSettings.SnapToGrid { get; set; }PUBLICGETSET

Snap positions to the grid

Returns:bool—

public string Sandbox.Gizmo.SceneSettings.ViewMode { get; set; }PUBLICGETSET

What is the current view mode? 3d, 2d, ui?

Returns:string—

public bool Sandbox.Gizmo.SceneSettings.WorldSpaceGizmos { get; set; }PUBLICGETSET

When enabled, component gizmo handles are drawn at a fixed world size instead of maintaining a constant screen size regardless of distance.

Returns:bool—

ClearPath()

Previous Page

AngleSpacing

Next Page

On this page

Constructorspublic SceneSettings()Methodspublic System.Void ClearEnabledGizmos()public System.Boolean IsGizmoEnabled(System.Type type)public System.Void SetGizmoEnabled(System.Type type, System.Boolean enabled)Propertiespublic System.Single Sandbox.Gizmo.SceneSettings.AngleSpacing { get; set; }public System.Boolean Sandbox.Gizmo.SceneSettings.DebugActionGraphs { get; set; }public System.String Sandbox.Gizmo.SceneSettings.EditMode { get; set; }public System.Boolean Sandbox.Gizmo.SceneSettings.GizmoDepthTest { get; set; }public System.Single Sandbox.Gizmo.SceneSettings.GizmoRenderDistance { get; set; }public System.Single Sandbox.Gizmo.SceneSettings.GizmoScale { get; set; }public System.Boolean Sandbox.Gizmo.SceneSettings.GizmosEnabled { get; set; }public System.Boolean Sandbox.Gizmo.SceneSettings.GlobalSpace { get; set; }public System.Single Sandbox.Gizmo.SceneSettings.GridSpacing { get; set; }public System.Boolean Sandbox.Gizmo.SceneSettings.Selection { get; set; }public System.Boolean Sandbox.Gizmo.SceneSettings.SnapToAngles { get; set; }public System.Boolean Sandbox.Gizmo.SceneSettings.SnapToGrid { get; set; }public System.String Sandbox.Gizmo.SceneSettings.ViewMode { get; set; }public System.Boolean Sandbox.Gizmo.SceneSettings.WorldSpaceGizmos { get; set; }Metadata