[−][src]Struct gdnative::api::SphereMesh
core class SphereMesh
inherits PrimitiveMesh
(reference counted).
Official documentation
See the documentation of this class in the Godot engine's official documentation.
Memory management
The lifetime of this object is automatically managed through reference counting.
Class hierarchy
SphereMesh 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 Access
in these types tracks whether the
access is unique, shared, or exclusive to the current thread. For more information,
see the type-level documentation on Ref
.
Implementations
impl SphereMesh
[src]
pub fn new() -> Ref<SphereMesh, Unique>
[src]
Creates a new instance of this object.
This is a reference-counted type. The returned object is automatically managed
by Ref
.
pub fn height(&self) -> f64
[src]
Full height of the sphere.
pub fn is_hemisphere(&self) -> bool
[src]
If [code]true[/code], a hemisphere is created rather than a full sphere.
[b]Note:[/b] To get a regular hemisphere, the height and radius of the sphere must be equal.
pub fn radial_segments(&self) -> i64
[src]
Number of radial segments on the sphere.
pub fn radius(&self) -> f64
[src]
Radius of sphere.
pub fn rings(&self) -> i64
[src]
Number of segments along the height of the sphere.
pub fn set_height(&self, height: f64)
[src]
Full height of the sphere.
pub fn set_is_hemisphere(&self, is_hemisphere: bool)
[src]
If [code]true[/code], a hemisphere is created rather than a full sphere.
[b]Note:[/b] To get a regular hemisphere, the height and radius of the sphere must be equal.
pub fn set_radial_segments(&self, radial_segments: i64)
[src]
Number of radial segments on the sphere.
pub fn set_radius(&self, radius: f64)
[src]
Radius of sphere.
pub fn set_rings(&self, rings: i64)
[src]
Number of segments along the height of the sphere.
Methods from Deref<Target = PrimitiveMesh>
pub fn custom_aabb(&self) -> Aabb
[src]
Overrides the [AABB] with one defined by user for use with frustum culling. Especially useful to avoid unnexpected culling when using a shader to offset vertices.
pub fn flip_faces(&self) -> bool
[src]
If set, the order of the vertices in each triangle are reversed resulting in the backside of the mesh being drawn.
This gives the same result as using [constant SpatialMaterial.CULL_BACK] in [member SpatialMaterial.params_cull_mode].
pub fn material(&self) -> Option<Ref<Material, Shared>>
[src]
The current [Material] of the primitive mesh.
pub fn get_mesh_arrays(&self) -> VariantArray<Shared>
[src]
Returns mesh arrays used to constitute surface of [Mesh]. The result can be passed to [method ArrayMesh.add_surface_from_arrays] to create a new surface. For example:
[codeblock]
var c := CylinderMesh.new()
var arr_mesh := ArrayMesh.new()
arr_mesh.add_surface_from_arrays(Mesh.PRIMITIVE_TRIANGLES, c.get_mesh_arrays())
[/codeblock]
pub fn set_custom_aabb(&self, aabb: Aabb)
[src]
Overrides the [AABB] with one defined by user for use with frustum culling. Especially useful to avoid unnexpected culling when using a shader to offset vertices.
pub fn set_flip_faces(&self, flip_faces: bool)
[src]
If set, the order of the vertices in each triangle are reversed resulting in the backside of the mesh being drawn.
This gives the same result as using [constant SpatialMaterial.CULL_BACK] in [member SpatialMaterial.params_cull_mode].
pub fn set_material(&self, material: impl AsArg<Material>)
[src]
The current [Material] of the primitive mesh.
Trait Implementations
impl Debug for SphereMesh
[src]
impl Deref for SphereMesh
[src]
type Target = PrimitiveMesh
The resulting type after dereferencing.
fn deref(&self) -> &PrimitiveMesh
[src]
impl DerefMut for SphereMesh
[src]
fn deref_mut(&mut self) -> &mut PrimitiveMesh
[src]
impl GodotObject for SphereMesh
[src]
type RefKind = RefCounted
The memory management kind of this type. This modifies the behavior of the
Ref
smart pointer. See its type-level documentation for more
information. Read more
fn class_name() -> &'static str
[src]
fn null() -> Null<Self>
[src]
fn new() -> Ref<Self, Unique> where
Self: Instanciable,
[src]
Self: Instanciable,
fn cast<T>(&self) -> Option<&T> where
T: GodotObject + SubClass<Self>,
[src]
T: GodotObject + SubClass<Self>,
fn upcast<T>(&self) -> &T where
Self: SubClass<T>,
T: GodotObject,
[src]
Self: SubClass<T>,
T: GodotObject,
unsafe fn assume_shared(&self) -> Ref<Self, Shared>
[src]
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
[src]
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_unique(&self) -> Ref<Self, Unique>
[src]
impl Instanciable for SphereMesh
[src]
fn construct() -> Ref<SphereMesh, Unique>
[src]
impl SubClass<Mesh> for SphereMesh
[src]
impl SubClass<Object> for SphereMesh
[src]
impl SubClass<PrimitiveMesh> for SphereMesh
[src]
impl SubClass<Reference> for SphereMesh
[src]
impl SubClass<Resource> for SphereMesh
[src]
Auto Trait Implementations
impl RefUnwindSafe for SphereMesh
impl !Send for SphereMesh
impl !Sync for SphereMesh
impl Unpin for SphereMesh
impl UnwindSafe for SphereMesh
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> SubClass<T> for T where
T: GodotObject,
[src]
T: GodotObject,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,