Struct gdnative_bindings::MeshDataTool
source · pub struct MeshDataTool { /* private fields */ }
Expand description
core class MeshDataTool
inherits Reference
(reference-counted).
Official documentation
See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.
Memory management
The lifetime of this object is automatically managed through reference counting.
Class hierarchy
MeshDataTool inherits methods from:
Safety
All types in the Godot API have interior mutability in Rust parlance.
To enforce that the official thread-safety guidelines are
followed, the typestate pattern is used in the Ref
and TRef
smart pointers,
and the Instance
API. The typestate Ownership
in these types tracks whether
ownership is unique, shared, or exclusive to the current thread. For more information,
see the type-level documentation on Ref
.
Implementations§
source§impl MeshDataTool
impl MeshDataTool
sourcepub fn new() -> Ref<Self, Unique>
pub fn new() -> Ref<Self, Unique>
Creates a new instance of this object.
This is a reference-counted type. The returned object is automatically managed
by Ref
.
sourcepub fn commit_to_surface(&self, mesh: impl AsArg<ArrayMesh>) -> GodotResult
pub fn commit_to_surface(&self, mesh: impl AsArg<ArrayMesh>) -> GodotResult
Adds a new surface to specified Mesh
with edited data.
sourcepub fn create_from_surface(
&self,
mesh: impl AsArg<ArrayMesh>,
surface: i64
) -> GodotResult
pub fn create_from_surface(
&self,
mesh: impl AsArg<ArrayMesh>,
surface: i64
) -> GodotResult
Uses specified surface of given Mesh
to populate data for MeshDataTool.
Requires Mesh
with primitive type Mesh.PRIMITIVE_TRIANGLES
.
sourcepub fn get_edge_count(&self) -> i64
pub fn get_edge_count(&self) -> i64
Returns the number of edges in this Mesh
.
sourcepub fn get_edge_faces(&self, idx: i64) -> PoolArray<i32>
pub fn get_edge_faces(&self, idx: i64) -> PoolArray<i32>
Returns array of faces that touch given edge.
sourcepub fn get_edge_meta(&self, idx: i64) -> Variant
pub fn get_edge_meta(&self, idx: i64) -> Variant
Returns meta information assigned to given edge.
sourcepub fn get_edge_vertex(&self, idx: i64, vertex: i64) -> i64
pub fn get_edge_vertex(&self, idx: i64, vertex: i64) -> i64
Returns index of specified vertex connected to given edge. Vertex argument can only be 0 or 1 because edges are comprised of two vertices.
sourcepub fn get_face_count(&self) -> i64
pub fn get_face_count(&self) -> i64
Returns the number of faces in this Mesh
.
sourcepub fn get_face_edge(&self, idx: i64, edge: i64) -> i64
pub fn get_face_edge(&self, idx: i64, edge: i64) -> i64
Returns specified edge associated with given face. Edge argument must be either 0, 1, or 2 because a face only has three edges.
sourcepub fn get_face_meta(&self, idx: i64) -> Variant
pub fn get_face_meta(&self, idx: i64) -> Variant
Returns the metadata associated with the given face.
sourcepub fn get_face_normal(&self, idx: i64) -> Vector3
pub fn get_face_normal(&self, idx: i64) -> Vector3
Calculates and returns the face normal of the given face.
sourcepub fn get_face_vertex(&self, idx: i64, vertex: i64) -> i64
pub fn get_face_vertex(&self, idx: i64, vertex: i64) -> i64
Returns the specified vertex of the given face. Vertex argument must be either 0, 1, or 2 because faces contain three vertices.
sourcepub fn get_format(&self) -> i64
pub fn get_format(&self) -> i64
Returns the Mesh
’s format. Format is an integer made up of Mesh
format flags combined together. For example, a mesh containing both vertices and normals would return a format of 3
because ArrayMesh.ARRAY_FORMAT_VERTEX
is 1
and ArrayMesh.ARRAY_FORMAT_NORMAL
is 2
.
See [enum ArrayMesh.ArrayFormat] for a list of format flags.
sourcepub fn get_material(&self) -> Option<Ref<Material, Shared>>
pub fn get_material(&self) -> Option<Ref<Material, Shared>>
Returns the material assigned to the Mesh
.
sourcepub fn get_vertex(&self, idx: i64) -> Vector3
pub fn get_vertex(&self, idx: i64) -> Vector3
Returns the vertex at given index.
sourcepub fn get_vertex_bones(&self, idx: i64) -> PoolArray<i32>
pub fn get_vertex_bones(&self, idx: i64) -> PoolArray<i32>
Returns the bones of the given vertex.
sourcepub fn get_vertex_color(&self, idx: i64) -> Color
pub fn get_vertex_color(&self, idx: i64) -> Color
Returns the color of the given vertex.
sourcepub fn get_vertex_count(&self) -> i64
pub fn get_vertex_count(&self) -> i64
Returns the total number of vertices in Mesh
.
sourcepub fn get_vertex_edges(&self, idx: i64) -> PoolArray<i32>
pub fn get_vertex_edges(&self, idx: i64) -> PoolArray<i32>
Returns an array of edges that share the given vertex.
sourcepub fn get_vertex_faces(&self, idx: i64) -> PoolArray<i32>
pub fn get_vertex_faces(&self, idx: i64) -> PoolArray<i32>
Returns an array of faces that share the given vertex.
sourcepub fn get_vertex_meta(&self, idx: i64) -> Variant
pub fn get_vertex_meta(&self, idx: i64) -> Variant
Returns the metadata associated with the given vertex.
sourcepub fn get_vertex_normal(&self, idx: i64) -> Vector3
pub fn get_vertex_normal(&self, idx: i64) -> Vector3
Returns the normal of the given vertex.
sourcepub fn get_vertex_tangent(&self, idx: i64) -> Plane
pub fn get_vertex_tangent(&self, idx: i64) -> Plane
Returns the tangent of the given vertex.
sourcepub fn get_vertex_uv(&self, idx: i64) -> Vector2
pub fn get_vertex_uv(&self, idx: i64) -> Vector2
Returns the UV of the given vertex.
sourcepub fn get_vertex_uv2(&self, idx: i64) -> Vector2
pub fn get_vertex_uv2(&self, idx: i64) -> Vector2
Returns the UV2 of the given vertex.
sourcepub fn get_vertex_weights(&self, idx: i64) -> PoolArray<f32>
pub fn get_vertex_weights(&self, idx: i64) -> PoolArray<f32>
Returns bone weights of the given vertex.
sourcepub fn set_edge_meta(&self, idx: i64, meta: impl OwnedToVariant)
pub fn set_edge_meta(&self, idx: i64, meta: impl OwnedToVariant)
Sets the metadata of the given edge.
sourcepub fn set_face_meta(&self, idx: i64, meta: impl OwnedToVariant)
pub fn set_face_meta(&self, idx: i64, meta: impl OwnedToVariant)
Sets the metadata of the given face.
sourcepub fn set_material(&self, material: impl AsArg<Material>)
pub fn set_material(&self, material: impl AsArg<Material>)
Sets the material to be used by newly-constructed Mesh
.
sourcepub fn set_vertex(&self, idx: i64, vertex: Vector3)
pub fn set_vertex(&self, idx: i64, vertex: Vector3)
Sets the position of the given vertex.
sourcepub fn set_vertex_bones(&self, idx: i64, bones: PoolArray<i32>)
pub fn set_vertex_bones(&self, idx: i64, bones: PoolArray<i32>)
Sets the bones of the given vertex.
sourcepub fn set_vertex_color(&self, idx: i64, color: Color)
pub fn set_vertex_color(&self, idx: i64, color: Color)
Sets the color of the given vertex.
sourcepub fn set_vertex_meta(&self, idx: i64, meta: impl OwnedToVariant)
pub fn set_vertex_meta(&self, idx: i64, meta: impl OwnedToVariant)
Sets the metadata associated with the given vertex.
sourcepub fn set_vertex_normal(&self, idx: i64, normal: Vector3)
pub fn set_vertex_normal(&self, idx: i64, normal: Vector3)
Sets the normal of the given vertex.
sourcepub fn set_vertex_tangent(&self, idx: i64, tangent: Plane)
pub fn set_vertex_tangent(&self, idx: i64, tangent: Plane)
Sets the tangent of the given vertex.
sourcepub fn set_vertex_uv(&self, idx: i64, uv: Vector2)
pub fn set_vertex_uv(&self, idx: i64, uv: Vector2)
Sets the UV of the given vertex.
sourcepub fn set_vertex_uv2(&self, idx: i64, uv2: Vector2)
pub fn set_vertex_uv2(&self, idx: i64, uv2: Vector2)
Sets the UV2 of the given vertex.
sourcepub fn set_vertex_weights(&self, idx: i64, weights: PoolArray<f32>)
pub fn set_vertex_weights(&self, idx: i64, weights: PoolArray<f32>)
Sets the bone weights of the given vertex.
Methods from Deref<Target = Object>§
pub const NOTIFICATION_POSTINITIALIZE: i64 = 0i64
pub const CONNECT_DEFERRED: i64 = 1i64
pub const NOTIFICATION_PREDELETE: i64 = 1i64
pub const CONNECT_PERSIST: i64 = 2i64
pub const CONNECT_ONESHOT: i64 = 4i64
pub const CONNECT_REFERENCE_COUNTED: i64 = 8i64
sourcepub fn add_user_signal(
&self,
signal: impl Into<GodotString>,
arguments: VariantArray
)
pub fn add_user_signal(
&self,
signal: impl Into<GodotString>,
arguments: VariantArray
)
Adds a user-defined signal
. Arguments are optional, but can be added as an Array
of dictionaries, each containing name: String
and type: int
(see [enum Variant.Type]) entries.
Default Arguments
arguments
-[ ]
sourcepub unsafe fn call(
&self,
method: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
pub unsafe fn call(
&self,
method: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
Sample code is GDScript unless otherwise noted.
Calls the method
on the object and returns the result. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:
call("set", "position", Vector2(42.0, 0.0))
Note: In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).
Safety
This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).
sourcepub unsafe fn call_deferred(
&self,
method: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
pub unsafe fn call_deferred(
&self,
method: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
Sample code is GDScript unless otherwise noted.
Calls the method
on the object during idle time. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:
call_deferred("set", "position", Vector2(42.0, 0.0))
Note: In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).
Safety
This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).
sourcepub unsafe fn callv(
&self,
method: impl Into<GodotString>,
arg_array: VariantArray
) -> Variant
pub unsafe fn callv(
&self,
method: impl Into<GodotString>,
arg_array: VariantArray
) -> Variant
Sample code is GDScript unless otherwise noted.
Calls the method
on the object and returns the result. Contrarily to call
, this method does not support a variable number of arguments but expects all parameters to be via a single Array
.
callv("set", [ "position", Vector2(42.0, 0.0) ])
Safety
This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).
sourcepub fn can_translate_messages(&self) -> bool
pub fn can_translate_messages(&self) -> bool
Returns true
if the object can translate strings. See set_message_translation
and tr
.
sourcepub fn connect(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>,
binds: VariantArray,
flags: i64
) -> GodotResult
pub fn connect(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>,
binds: VariantArray,
flags: i64
) -> GodotResult
Sample code is GDScript unless otherwise noted.
Connects a signal
to a method
on a target
object. Pass optional binds
to the call as an Array
of parameters. These parameters will be passed to the method after any parameter used in the call to emit_signal
. Use flags
to set deferred or one-shot connections. See ConnectFlags
constants.
A signal
can only be connected once to a method
. It will print an error if already connected, unless the signal was connected with CONNECT_REFERENCE_COUNTED
. To avoid this, first, use is_connected
to check for existing connections.
If the target
is destroyed in the game’s lifecycle, the connection will be lost.
Examples:
connect("pressed", self, "_on_Button_pressed") # BaseButton signal
connect("text_entered", self, "_on_LineEdit_text_entered") # LineEdit signal
connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # User-defined signal
An example of the relationship between binds
passed to connect
and parameters used when calling emit_signal
:
connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # weapon_type and damage are passed last
emit_signal("hit", "Dark lord", 5) # "Dark lord" and 5 are passed first
func _on_Player_hit(hit_by, level, weapon_type, damage):
print("Hit by %s (lvl %d) with weapon %s for %d damage" % [hit_by, level, weapon_type, damage])
Default Arguments
binds
-[ ]
flags
-0
sourcepub fn disconnect(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>
)
pub fn disconnect(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>
)
Disconnects a signal
from a method
on the given target
.
If you try to disconnect a connection that does not exist, the method will print an error. Use is_connected
to ensure that the connection exists.
sourcepub fn emit_signal(
&self,
signal: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
pub fn emit_signal(
&self,
signal: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
Sample code is GDScript unless otherwise noted.
Emits the given signal
. The signal must exist, so it should be a built-in signal of this class or one of its parent classes, or a user-defined signal. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:
emit_signal("hit", weapon_type, damage)
emit_signal("game_over")
sourcepub fn get(&self, property: impl Into<GodotString>) -> Variant
pub fn get(&self, property: impl Into<GodotString>) -> Variant
Returns the Variant
value of the given property
. If the property
doesn’t exist, this will return null
.
Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).
sourcepub fn get_class(&self) -> GodotString
pub fn get_class(&self) -> GodotString
sourcepub fn get_incoming_connections(&self) -> VariantArray
pub fn get_incoming_connections(&self) -> VariantArray
Returns an Array
of dictionaries with information about signals that are connected to the object.
Each Dictionary
contains three String entries:
source
is a reference to the signal emitter.signal_name
is the name of the connected signal.method_name
is the name of the method to which the signal is connected.
sourcepub fn get_indexed(&self, property: impl Into<NodePath>) -> Variant
pub fn get_indexed(&self, property: impl Into<NodePath>) -> Variant
Gets the object’s property indexed by the given NodePath
. The node path should be relative to the current object and can use the colon character (:
) to access nested properties. Examples: "position:x"
or "material:next_pass:blend_mode"
.
Note: Even though the method takes NodePath
argument, it doesn’t support actual paths to Node
s in the scene tree, only colon-separated sub-property paths. For the purpose of nodes, use Node.get_node_and_resource
instead.
sourcepub fn get_instance_id(&self) -> i64
pub fn get_instance_id(&self) -> i64
Returns the object’s unique instance ID.
This ID can be saved in EncodedObjectAsID
, and can be used to retrieve the object instance with [method @GDScript.instance_from_id].
sourcepub fn get_meta(
&self,
name: impl Into<GodotString>,
default: impl OwnedToVariant
) -> Variant
pub fn get_meta(
&self,
name: impl Into<GodotString>,
default: impl OwnedToVariant
) -> Variant
Returns the object’s metadata entry for the given name
.
Throws error if the entry does not exist, unless default
is not null
(in which case the default value will be returned).
Default Arguments
default
-null
sourcepub fn get_meta_list(&self) -> PoolArray<GodotString>
pub fn get_meta_list(&self) -> PoolArray<GodotString>
Returns the object’s metadata as a PoolStringArray
.
sourcepub fn get_method_list(&self) -> VariantArray
pub fn get_method_list(&self) -> VariantArray
Returns the object’s methods and their signatures as an Array
.
sourcepub fn get_property_list(&self) -> VariantArray
pub fn get_property_list(&self) -> VariantArray
Returns the object’s property list as an Array
of dictionaries.
Each property’s Dictionary
contain at least name: String
and type: int
(see [enum Variant.Type]) entries. Optionally, it can also include hint: int
(see [PropertyHint
][PropertyHint]), hint_string: String
, and usage: int
(see [PropertyUsageFlags
][PropertyUsageFlags]).
sourcepub fn get_script(&self) -> Option<Ref<Reference, Shared>>
pub fn get_script(&self) -> Option<Ref<Reference, Shared>>
Returns the object’s Script
instance, or null
if none is assigned.
sourcepub fn get_signal_connection_list(
&self,
signal: impl Into<GodotString>
) -> VariantArray
pub fn get_signal_connection_list(
&self,
signal: impl Into<GodotString>
) -> VariantArray
Returns an Array
of connections for the given signal
.
sourcepub fn get_signal_list(&self) -> VariantArray
pub fn get_signal_list(&self) -> VariantArray
Returns the list of signals as an Array
of dictionaries.
sourcepub fn has_meta(&self, name: impl Into<GodotString>) -> bool
pub fn has_meta(&self, name: impl Into<GodotString>) -> bool
Returns true
if a metadata entry is found with the given name
.
sourcepub fn has_method(&self, method: impl Into<GodotString>) -> bool
pub fn has_method(&self, method: impl Into<GodotString>) -> bool
Returns true
if the object contains the given method
.
sourcepub fn has_signal(&self, signal: impl Into<GodotString>) -> bool
pub fn has_signal(&self, signal: impl Into<GodotString>) -> bool
Returns true
if the given signal
exists.
sourcepub fn has_user_signal(&self, signal: impl Into<GodotString>) -> bool
pub fn has_user_signal(&self, signal: impl Into<GodotString>) -> bool
Returns true
if the given user-defined signal
exists. Only signals added using add_user_signal
are taken into account.
sourcepub fn is_blocking_signals(&self) -> bool
pub fn is_blocking_signals(&self) -> bool
Returns true
if signal emission blocking is enabled.
sourcepub fn is_class(&self, class: impl Into<GodotString>) -> bool
pub fn is_class(&self, class: impl Into<GodotString>) -> bool
sourcepub fn is_connected(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>
) -> bool
pub fn is_connected(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>
) -> bool
Returns true
if a connection exists for a given signal
, target
, and method
.
sourcepub fn is_queued_for_deletion(&self) -> bool
pub fn is_queued_for_deletion(&self) -> bool
Returns true
if the Node.queue_free
method was called for the object.
sourcepub fn notification(&self, what: i64, reversed: bool)
pub fn notification(&self, what: i64, reversed: bool)
Send a given notification to the object, which will also trigger a call to the [_notification
][Self::_notification] method of all classes that the object inherits from.
If reversed
is true
, [_notification
][Self::_notification] is called first on the object’s own class, and then up to its successive parent classes. If reversed
is false
, [_notification
][Self::_notification] is called first on the highest ancestor (Object
itself), and then down to its successive inheriting classes.
Default Arguments
reversed
-false
sourcepub fn property_list_changed_notify(&self)
pub fn property_list_changed_notify(&self)
Notify the editor that the property list has changed, so that editor plugins can take the new values into account. Does nothing on export builds.
sourcepub fn remove_meta(&self, name: impl Into<GodotString>)
pub fn remove_meta(&self, name: impl Into<GodotString>)
Removes a given entry from the object’s metadata. See also set_meta
.
sourcepub fn set(&self, property: impl Into<GodotString>, value: impl OwnedToVariant)
pub fn set(&self, property: impl Into<GodotString>, value: impl OwnedToVariant)
Assigns a new value to the given property. If the property
does not exist or the given value’s type doesn’t match, nothing will happen.
Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).
sourcepub fn set_block_signals(&self, enable: bool)
pub fn set_block_signals(&self, enable: bool)
If set to true
, signal emission is blocked.
sourcepub fn set_deferred(
&self,
property: impl Into<GodotString>,
value: impl OwnedToVariant
)
pub fn set_deferred(
&self,
property: impl Into<GodotString>,
value: impl OwnedToVariant
)
Assigns a new value to the given property, after the current frame’s physics step. This is equivalent to calling set
via call_deferred
, i.e. call_deferred("set", property, value)
.
Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).
sourcepub fn set_indexed(
&self,
property: impl Into<NodePath>,
value: impl OwnedToVariant
)
pub fn set_indexed(
&self,
property: impl Into<NodePath>,
value: impl OwnedToVariant
)
Sample code is GDScript unless otherwise noted.
Assigns a new value to the property identified by the NodePath
. The node path should be relative to the current object and can use the colon character (:
) to access nested properties. Example:
set_indexed("position", Vector2(42, 0))
set_indexed("position:y", -10)
print(position) # (42, -10)
sourcepub fn set_message_translation(&self, enable: bool)
pub fn set_message_translation(&self, enable: bool)
Defines whether the object can translate strings (with calls to tr
). Enabled by default.
sourcepub fn set_meta(&self, name: impl Into<GodotString>, value: impl OwnedToVariant)
pub fn set_meta(&self, name: impl Into<GodotString>, value: impl OwnedToVariant)
Adds, changes or removes a given entry in the object’s metadata. Metadata are serialized and can take any Variant
value.
To remove a given entry from the object’s metadata, use remove_meta
. Metadata is also removed if its value is set to null
. This means you can also use set_meta("name", null)
to remove metadata for "name"
.
sourcepub fn set_script(&self, script: impl AsArg<Reference>)
pub fn set_script(&self, script: impl AsArg<Reference>)
Assigns a script to the object. Each object can have a single script assigned to it, which are used to extend its functionality.
If the object already had a script, the previous script instance will be freed and its variables and state will be lost. The new script’s [_init
][Self::_init] method will be called.
sourcepub fn to_string(&self) -> GodotString
pub fn to_string(&self) -> GodotString
sourcepub fn tr(&self, message: impl Into<GodotString>) -> GodotString
pub fn tr(&self, message: impl Into<GodotString>) -> GodotString
Translates a message using translation catalogs configured in the Project Settings.
Only works if message translation is enabled (which it is by default), otherwise it returns the message
unchanged. See set_message_translation
.
Trait Implementations§
source§impl Debug for MeshDataTool
impl Debug for MeshDataTool
source§impl Deref for MeshDataTool
impl Deref for MeshDataTool
source§impl DerefMut for MeshDataTool
impl DerefMut for MeshDataTool
source§impl GodotObject for MeshDataTool
impl GodotObject for MeshDataTool
§type Memory = RefCounted
type Memory = RefCounted
Ref
smart pointer. See its type-level documentation for more
information.fn class_name() -> &'static str
source§fn null() -> Null<Self>
fn null() -> Null<Self>
Self
as a method argument. This makes type
inference easier for the compiler compared to Option
.source§fn new() -> Ref<Self, Unique>where
Self: Instanciable,
fn new() -> Ref<Self, Unique>where
Self: Instanciable,
Self
using a zero-argument constructor, as a Unique
reference.