VisualInstance3D

package
v0.0.0-...-e1beaa7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 16, 2025 License: MIT Imports: 25 Imported by: 0

Documentation

Overview

The graphics.gd/classdb/VisualInstance3D is used to connect a resource to a visual representation. All visual 3D nodes inherit from the graphics.gd/classdb/VisualInstance3D. In general, you should not access the graphics.gd/classdb/VisualInstance3D properties directly as they are accessed and managed by the nodes that inherit from graphics.gd/classdb/VisualInstance3D. graphics.gd/classdb/VisualInstance3D is the node representation of the graphics.gd/classdb/RenderingServer instance.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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
	AsVisualInstance3D() Instance
}

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this [Extension]See Interface for methods that can be overridden by T.

func (*Extension[T]) AsNode

func (self *Extension[T]) AsNode() Node.Instance

func (*Extension[T]) AsNode3D

func (self *Extension[T]) AsNode3D() Node3D.Instance

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsVisualInstance3D

func (self *Extension[T]) AsVisualInstance3D() Instance

type ID

type ID Object.ID

ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Implementation

type Implementation = implementation

Implementation implements Interface with empty methods.

type Instance

type Instance [1]gdclass.VisualInstance3D

Instance of the class with convieniently typed arguments and results.

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) AsVisualInstance3D

func (self Instance) AsVisualInstance3D() Instance

func (Instance) GetAabb

func (self Instance) GetAabb() AABB.PositionSize

Returns the [AABB.PositionSize] (also known as the bounding box) for this graphics.gd/classdb/VisualInstance3D.

func (Instance) GetBase

func (self Instance) GetBase() RID.VisualInstance

Returns the RID of the resource associated with this graphics.gd/classdb/VisualInstance3D. For example, if the Node is a graphics.gd/classdb/MeshInstance3D, this will return the RID of the associated graphics.gd/classdb/Mesh.

func (Instance) GetInstance

func (self Instance) GetInstance() RID.VisualInstance

Returns the RID of this instance. This RID is the same as the RID returned by graphics.gd/classdb/RenderingServer.InstanceCreate. This RID is needed if you want to call graphics.gd/classdb/RenderingServer functions directly on this graphics.gd/classdb/VisualInstance3D.

func (Instance) GetLayerMaskValue

func (self Instance) GetLayerMaskValue(layer_number int) bool

Returns whether or not the specified layer of the Instance.Layers is enabled, given a 'layer_number' between 1 and 20.

func (Instance) ID

func (self Instance) ID() ID

func (Instance) Layers

func (self Instance) Layers() int

func (Instance) SetBase

func (self Instance) SetBase(base RID.VisualInstance)

Sets the resource that is instantiated by this graphics.gd/classdb/VisualInstance3D, which changes how the engine handles the graphics.gd/classdb/VisualInstance3D under the hood. Equivalent to graphics.gd/classdb/RenderingServer.InstanceSetBase.

func (Instance) SetLayerMaskValue

func (self Instance) SetLayerMaskValue(layer_number int, value bool)

Based on 'value', enables or disables the specified layer in the Instance.Layers, given a 'layer_number' between 1 and 20.

func (Instance) SetLayers

func (self Instance) SetLayers(value int)

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetSortingOffset

func (self Instance) SetSortingOffset(value Float.X)

func (Instance) SetSortingUseAabbCenter

func (self Instance) SetSortingUseAabbCenter(value bool)

func (Instance) SortingOffset

func (self Instance) SortingOffset() Float.X

func (Instance) SortingUseAabbCenter

func (self Instance) SortingUseAabbCenter() bool

func (Instance) Virtual

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

type Interface

type Interface interface {
	GetAabb() AABB.PositionSize
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL