VisibleOnScreenNotifier3D

Documentation

Overview

Package VisibleOnScreenNotifier3D provides methods for working with VisibleOnScreenNotifier3D object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AsNode() Node.Instance
  • func (self Instance) AsNode3D() Node3D.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsVisibleOnScreenNotifier3D() Instance
  • func (self Instance) AsVisualInstance3D() VisualInstance3D.Instance
  • func (self Instance) IsOnScreen() bool
  • func (self Instance) OnScreenEntered(cb func())
  • func (self Instance) OnScreenExited(cb func())
  • func (self Instance) SetAabb(value AABB.PositionSize)
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsVisibleOnScreenNotifier3D() Instance
}

type Instance

type Instance [1]gdclass.VisibleOnScreenNotifier3D

[VisibleOnScreenNotifier3D] represents a box-shaped region of 3D space. When any part of this region becomes visible on screen or in a [Camera3D]'s view, it will emit a [signal screen_entered] signal, and likewise it will emit a [signal screen_exited] signal when no part of it remains visible. If you want a node to be enabled automatically when this region is visible on screen, use [VisibleOnScreenEnabler3D]. [b]Note:[/b] [VisibleOnScreenNotifier3D] uses an approximate heuristic that doesn't take walls and other occlusion into account, unless occlusion culling is used. It also won't function unless [member Node3D.visible] is set to [code]true[/code].

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsNode

func (self Instance) AsNode() Node.Instance

func (Instance) AsNode3D

func (self Instance) AsNode3D() Node3D.Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsVisibleOnScreenNotifier3D

func (self Instance) AsVisibleOnScreenNotifier3D() Instance

func (Instance) AsVisualInstance3D

func (self Instance) AsVisualInstance3D() VisualInstance3D.Instance

func (Instance) IsOnScreen

func (self Instance) IsOnScreen() bool

Returns [code]true[/code] if the bounding box is on the screen. [b]Note:[/b] It takes one frame for the [VisibleOnScreenNotifier3D]'s visibility to be assessed once added to the scene tree, so this method will always return [code]false[/code] right after it is instantiated.

func (Instance) OnScreenEntered

func (self Instance) OnScreenEntered(cb func())

func (Instance) OnScreenExited

func (self Instance) OnScreenExited(cb func())

func (Instance) SetAabb

func (self Instance) SetAabb(value AABB.PositionSize)

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value