Struct bigbang::Entity

#[repr(C)]
pub struct Entity {
    pub vx: f64,
    pub vy: f64,
    pub vz: f64,
    pub x: f64,
    pub y: f64,
    pub z: f64,
    pub radius: f64,
    pub mass: f64,
}

An Entity is an object (generalized to be spherical, having only a radius dimension) which has velocity, position, radius, and mass. This gravitational tree contains many entities and it moves them around according to the gravity they exert on each other.

Fields

vx: f64

vy: f64

vz: f64

x: f64

y: f64

z: f64

radius: f64

mass: f64

Methods

impl Entity

pub fn random_entity() -> Entity

Convenience function for testing. Generates an entity with random properties.

pub fn apply_gravity_from<T: AsEntity + Clone>(
    &self,
    node: &Node<T>
) -> (f64, f64, f64)

Returns a new entity after gravity from a node has been applied to it. Should be read as "apply gravity from node"

pub fn as_string(&self) -> String

Returns the entity as a string with space separated values.

pub fn get_dim(&self, dim: &Dimension) -> &f64

pub fn get_entity_acceleration_from<T: AsEntity + Clone>(
    &self,
    node: &Node<T>
) -> (f64, f64, f64)

Returns the acceleration of an entity after it has had gravity from the specified node applied to it. In this function, we approximate some entities if they exceed a certain critera specified in "exceeds_theta()". If we reach a node and it is a leaf, then we automatically get the acceleration from every entity in that node, but if we reach a node that is not a leaf and exceeds_theta() is true, then we treat the node as one giant entity and get the acceleration from it.

Trait Implementations

impl AsEntity for Entity

fn as_entity(&self) -> Entity

fn apply_acceleration(
    &self,
    acceleration: (f64, f64, f64),
    time_step: f64
) -> Self

impl Default for Entity

fn default() -> Entity

Returns the "default value" for a type.

impl Clone for Entity

fn clone(&self) -> Entity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<Entity> for Entity

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.