Struct Geometry

pub struct Geometry { /* private fields */ }

An interface that allows the setup and modification of geometry for occlusion.

Implementations

impl Geometry

pub fn add_polygon( &self, direct_occlusion: c_float, reverb_occlusion: c_float, double_sided: bool, vertices: &[Vector], ) -> Result<c_int>

Adds a polygon.

All vertices must lay in the same plane otherwise behavior may be unpredictable. The polygon is assumed to be convex. A non convex polygon will produce unpredictable behavior. Polygons with zero area will be ignored.

Polygons cannot be added if already at the maximum number of polygons or if the addition of their verticies would result in exceeding the maximum number of vertices.

Vertices of an object are in object space, not world space, and so are relative to the position, or center of the object. See Geometry::set_position.

pub fn set_active(&self, active: bool) -> Result<()>

Sets whether an object is processed by the geometry engine.

pub fn get_active(&self) -> Result<bool>

Retrieves whether an object is processed by the geometry engine.

pub fn get_max_polygons(&self) -> Result<(c_int, c_int)>

Retrieves the maximum number of polygons and vertices allocatable for this object.

The maximum number was set with crate::System::create_geometry.

pub fn get_polygon_count(&self) -> Result<c_int>

Retrieves the number of polygons in this object.

pub fn set_userdata(&self, userdata: *mut c_void) -> Result<()>

Sets the user data.

pub fn get_userdata(&self) -> Result<*mut c_void>

Retrieves user data.

pub fn release(&self) -> Result<()>

Frees a geometry object and releases its memory.

pub fn save(&self) -> Result<Vec<u8>>

Saves the geometry object as a serialized binary block to a Vec.

The data can be saved to a file if required and loaded later with crate::System::load_geometry.

impl Geometry

pub fn set_polygon_attributes( &self, index: c_int, direct_occlusion: c_float, reverb_occlusion: c_float, double_sided: bool, ) -> Result<()>

Sets individual attributes for a polygon inside a geometry object.

pub fn get_polygon_attributes( &self, index: c_int, ) -> Result<(c_float, c_float, bool)>

Retrieves the attributes for a polygon.

pub fn get_polygon_vertex_count(&self, index: c_int) -> Result<c_int>

Gets the number of vertices in a polygon.

pub fn set_polygon_vertex( &self, index: c_int, vertex_index: c_int, vertex: Vector, ) -> Result<()>

Alters the position of a polygon’s vertex inside a geometry object.

Vertices are relative to the position of the object. See Geometry::set_position.

There may be some significant overhead with this function as it may cause some reconfiguration of internal data structures used to speed up sound-ray testing.

You may get better results if you want to modify your object by using Geometry::set_position, Geometry::set_scale and Geometry::set_rotation.

pub fn get_polygon_vertex( &self, index: c_int, vertex_index: c_int, ) -> Result<Vector>

Retrieves the position of a vertex.

Vertices are relative to the position of the object. See Geometry::set_position.

impl Geometry

pub fn set_position(&self, position: Vector) -> Result<()>

Sets the 3D position of the object.

Position is in world space.

pub fn get_position(&self) -> Result<Vector>

Retrieves the 3D position of the object.

Position is in world space.

pub fn set_rotation(&self, forward: Vector, up: Vector) -> Result<()>

Sets the 3D orientation of the object.

See remarks in crate::System::set_3d_listener_attributes for more description on forward and up vectors.

pub fn get_rotation(&self) -> Result<(Vector, Vector)>

Retrieves the 3D orientation of the object.

pub fn set_scale(&self, scale: Vector) -> Result<()>

Sets the 3D scale of the object.

An object can be scaled/warped in all 3 dimensions separately using this function without having to modify polygon data.

pub fn get_scale(&self) -> Result<Vector>

Retrieves the 3D scale of the object.

impl Geometry

pub unsafe fn from_ffi(value: *mut FMOD_GEOMETRY) -> Self

Safety

value must be a valid pointer either aquired from Self::as_ptr or FMOD.

Panics

Panics if value is null.

pub fn as_ptr(self) -> *mut FMOD_GEOMETRY

Converts self into its raw representation.

Trait Implementations

impl Clone for Geometry

fn clone(&self) -> Geometry

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Geometry

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Geometry> for *mut FMOD_GEOMETRY

fn from(value: Geometry) -> Self

Converts to this type from the input type.

impl Hash for Geometry

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Geometry

fn eq(&self, other: &Geometry) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Geometry

impl Eq for Geometry

impl Send for Geometry

Available on non-crate feature thread-unsafe only.

impl StructuralPartialEq for Geometry

impl Sync for Geometry

Available on non-crate feature thread-unsafe only.