Struct godot::classes::SurfaceTool

#[repr(C)]
pub struct SurfaceTool { /* private fields */ }

Expand description

Godot class SurfaceTool.

Inherits RefCounted.

Related symbols:

surface_tool: sidecar module with related enum/flag types
ISurfaceTool: virtual methods

§Construction

This class is reference-counted. You can create a new instance using SurfaceTool::new_gd().

Implementations§

§

impl SurfaceTool

pub fn set_skin_weight_count(&mut self, count: SkinWeightCount)

pub fn get_skin_weight_count(&self) -> SkinWeightCount

pub fn set_custom_format(&mut self, channel_index: i32, format: CustomFormat)

pub fn get_custom_format(&self, channel_index: i32) -> CustomFormat

pub fn begin(&mut self, primitive: PrimitiveType)

pub fn add_vertex(&mut self, vertex: Vector3)

pub fn set_color(&mut self, color: Color)

pub fn set_normal(&mut self, normal: Vector3)

pub fn set_tangent(&mut self, tangent: Plane)

pub fn set_uv(&mut self, uv: Vector2)

pub fn set_uv2(&mut self, uv2: Vector2)

pub fn set_bones(&mut self, bones: PackedInt32Array)

pub fn set_weights(&mut self, weights: PackedFloat32Array)

pub fn set_custom(&mut self, channel_index: i32, custom_color: Color)

pub fn set_smooth_group(&mut self, index: u32)

pub fn add_triangle_fan(&mut self, vertices: PackedVector3Array)

pub fn add_triangle_fan_ex( &mut self, vertices: PackedVector3Array, ) -> ExAddTriangleFan<'_>

pub fn add_index(&mut self, index: i32)

pub fn index(&mut self)

pub fn deindex(&mut self)

pub fn generate_normals(&mut self)

pub fn generate_normals_ex(&mut self) -> ExGenerateNormals<'_>

pub fn generate_tangents(&mut self)

pub fn optimize_indices_for_cache(&mut self)

pub fn get_aabb(&self) -> Aabb

pub fn generate_lod(&mut self, nd_threshold: f32) -> PackedInt32Array

pub fn generate_lod_ex(&mut self, nd_threshold: f32) -> ExGenerateLod<'_>

pub fn set_material(&mut self, material: Gd<Material>)

pub fn get_primitive_type(&self) -> PrimitiveType

pub fn clear(&mut self)

pub fn create_from(&mut self, existing: Gd<Mesh>, surface: i32)

pub fn create_from_arrays(&mut self, arrays: OutArray)

pub fn create_from_arrays_ex( &mut self, arrays: OutArray, ) -> ExCreateFromArrays<'_>

pub fn create_from_blend_shape( &mut self, existing: Gd<Mesh>, surface: i32, blend_shape: GString, )

pub fn append_from( &mut self, existing: Gd<Mesh>, surface: i32, transform: Transform3D, )

pub fn commit(&mut self) -> Option<Gd<ArrayMesh>>

pub fn commit_ex(&mut self) -> ExCommit<'_>

pub fn commit_to_arrays(&mut self) -> OutArray

Methods from Deref<Target = RefCounted>§

pub fn get_reference_count(&self) -> i32

Methods from Deref<Target = Object>§

pub fn get_class(&self) -> GString

pub fn is_class(&self, class: GString) -> bool

pub fn set(&mut self, property: StringName, value: Variant)

pub fn get(&self, property: StringName) -> Variant

pub fn set_indexed(&mut self, property_path: NodePath, value: Variant)

pub fn get_indexed(&self, property_path: NodePath) -> Variant

pub fn get_property_list(&self) -> Array<Dictionary>

pub fn get_method_list(&self) -> Array<Dictionary>

pub fn property_can_revert(&self, property: StringName) -> bool

pub fn property_get_revert(&self, property: StringName) -> Variant

pub fn set_script(&mut self, script: Variant)

pub fn get_script(&self) -> Variant

pub fn set_meta(&mut self, name: StringName, value: Variant)

pub fn remove_meta(&mut self, name: StringName)

pub fn get_meta(&self, name: StringName) -> Variant

pub fn get_meta_ex(&self, name: StringName) -> ExGetMeta<'_>

pub fn has_meta(&self, name: StringName) -> bool

pub fn get_meta_list(&self) -> Array<StringName>

pub fn add_user_signal(&mut self, signal: GString)

pub fn add_user_signal_ex(&mut self, signal: GString) -> ExAddUserSignal<'_>

pub fn has_user_signal(&self, signal: StringName) -> bool

pub fn remove_user_signal(&mut self, signal: StringName)

pub fn emit_signal(&mut self, signal: StringName, varargs: &[Variant]) -> Error

§Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_emit_signal( &mut self, signal: StringName, varargs: &[Variant], ) -> Result<Error, CallError>

§Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call(&mut self, method: StringName, varargs: &[Variant]) -> Variant

§Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>

§Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call_deferred( &mut self, method: StringName, varargs: &[Variant], ) -> Variant

§Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call_deferred( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>

§Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn set_deferred(&mut self, property: StringName, value: Variant)

pub fn callv(&mut self, method: StringName, arg_array: OutArray) -> Variant

pub fn has_method(&self, method: StringName) -> bool

pub fn get_method_argument_count(&self, method: StringName) -> i32

pub fn has_signal(&self, signal: StringName) -> bool

pub fn get_signal_list(&self) -> Array<Dictionary>

pub fn get_signal_connection_list( &self, signal: StringName, ) -> Array<Dictionary>

pub fn get_incoming_connections(&self) -> Array<Dictionary>

pub fn connect(&mut self, signal: StringName, callable: Callable) -> Error

pub fn connect_ex( &mut self, signal: StringName, callable: Callable, ) -> ExConnect<'_>

pub fn disconnect(&mut self, signal: StringName, callable: Callable)

pub fn is_connected(&self, signal: StringName, callable: Callable) -> bool

pub fn set_block_signals(&mut self, enable: bool)

pub fn is_blocking_signals(&self) -> bool

pub fn notify_property_list_changed(&mut self)

pub fn set_message_translation(&mut self, enable: bool)

pub fn can_translate_messages(&self) -> bool

pub fn tr(&self, message: StringName) -> GString

pub fn tr_ex(&self, message: StringName) -> ExTr<'_>

pub fn tr_n( &self, message: StringName, plural_message: StringName, n: i32, ) -> GString

pub fn tr_n_ex( &self, message: StringName, plural_message: StringName, n: i32, ) -> ExTrN<'_>

pub fn is_queued_for_deletion(&self) -> bool

pub fn cancel_free(&mut self)

pub fn notify(&mut self, what: ObjectNotification)

⚠️ Sends a Godot notification to all classes inherited by the object.

Triggers calls to on_notification(), and depending on the notification, also to Godot’s lifecycle callbacks such as ready().

Starts from the highest ancestor (the Object class) and goes down the hierarchy. See also Godot docs for Object::notification().

§Panics

If you call this method on a user-defined object while holding a GdRef or GdMut guard on the instance, you will encounter a panic. The reason is that the receiving virtual method on_notification() acquires a GdMut lock dynamically, which must be exclusive.