Documentation
¶
Overview ¶
Package VisualInstance3D provides methods for working with VisualInstance3D object instances.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Implementation
- type Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsNode3D() Node3D.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsVisualInstance3D() Instance
- func (self Instance) GetAabb() AABB.PositionSize
- func (self Instance) GetBase() RID.VisualInstance
- func (self Instance) GetInstance() RID.VisualInstance
- func (self Instance) GetLayerMaskValue(layer_number int) bool
- func (self Instance) ID() ID
- func (self Instance) Layers() int
- func (self Instance) SetBase(base RID.VisualInstance)
- func (self Instance) SetLayerMaskValue(layer_number int, value bool)
- func (self Instance) SetLayers(value int)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetSortingOffset(value Float.X)
- func (self Instance) SetSortingUseAabbCenter(value bool)
- func (self Instance) SortingOffset() Float.X
- func (self Instance) SortingUseAabbCenter() bool
- func (self *Instance) UnsafePointer() unsafe.Pointer
- func (self Instance) Virtual(name string) reflect.Value
- type Interface
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 Extension ¶
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
func (*Extension[T]) AsVisualInstance3D ¶
type 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.
type Implementation ¶
type Implementation = implementation
Implementation implements Interface with empty methods.
type Instance ¶
type Instance [1]gdclass.VisualInstance3D
The [VisualInstance3D] is used to connect a resource to a visual representation. All visual 3D nodes inherit from the [VisualInstance3D]. In general, you should not access the [VisualInstance3D] properties directly as they are accessed and managed by the nodes that inherit from [VisualInstance3D]. [VisualInstance3D] is the node representation of the [RenderingServer] instance.
See [Interface] for methods that can be overridden by a [Class] that extends it.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsVisualInstance3D ¶
func (Instance) GetAabb ¶
func (self Instance) GetAabb() AABB.PositionSize
Returns the [AABB] (also known as the bounding box) for this [VisualInstance3D].
func (Instance) GetBase ¶
func (self Instance) GetBase() RID.VisualInstance
Returns the RID of the resource associated with this [VisualInstance3D]. For example, if the Node is a [MeshInstance3D], this will return the RID of the associated [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 [method RenderingServer.instance_create]. This RID is needed if you want to call [RenderingServer] functions directly on this [VisualInstance3D].
func (Instance) GetLayerMaskValue ¶
Returns whether or not the specified layer of the [member layers] is enabled, given a [param layer_number] between 1 and 20.
func (Instance) SetBase ¶
func (self Instance) SetBase(base RID.VisualInstance)
Sets the resource that is instantiated by this [VisualInstance3D], which changes how the engine handles the [VisualInstance3D] under the hood. Equivalent to [method RenderingServer.instance_set_base].
func (Instance) SetLayerMaskValue ¶
Based on [param value], enables or disables the specified layer in the [member layers], given a [param layer_number] between 1 and 20.
func (Instance) SetSortingOffset ¶
func (Instance) SetSortingUseAabbCenter ¶
func (Instance) SortingOffset ¶
func (Instance) SortingUseAabbCenter ¶
func (*Instance) UnsafePointer ¶
type Interface ¶
type Interface interface {
GetAabb() AABB.PositionSize
}
Source Files