Trait stepper_lib::comp::tool::Tool

pub trait Tool: Debug {
    // Required methods
    fn mount(&mut self);
    fn dismount(&mut self);
    fn get_json(&self) -> Value;
    fn vec(&self) -> Vec3;
    fn inertia(&self) -> Inertia;
    fn mass(&self) -> f32;

    // Provided methods
    fn simple_tool(&self) -> Option<&dyn SimpleTool> { ... }
    fn simple_tool_mut(&mut self) -> Option<&mut dyn SimpleTool> { ... }
    fn axis_tool(&self) -> Option<&dyn AxisTool> { ... }
    fn axis_tool_mut(&mut self) -> Option<&mut dyn AxisTool> { ... }
    fn spindle_tool(&self) -> Option<&dyn SpindleTool> { ... }
    fn spindle_tool_mut(&mut self) -> Option<&mut dyn SpindleTool> { ... }
    fn get_type_name(&self) -> &str { ... }
}

General tool trait

Required Methods

fn mount(&mut self)

Mounts the component.

Comparable to a “setup” / “activate” function

fn dismount(&mut self)

Dismounts the component.

Comparable to a “deactivate” function

fn get_json(&self) -> Value

Returns the tool described as JSON-Object

fn vec(&self) -> Vec3

Returns the characteristic vector of the tool

fn inertia(&self) -> Inertia

Returns the tool inhertia

fn mass(&self) -> f32

Return the tool mass

Provided Methods

fn simple_tool(&self) -> Option<&dyn SimpleTool>

Upgrade the tool to a SimpleTool if possible, returns None otherwise

fn simple_tool_mut(&mut self) -> Option<&mut dyn SimpleTool>

Upgrade the tool to a SimpleTool if possible, returns None otherwise

fn axis_tool(&self) -> Option<&dyn AxisTool>

Upgrade the tool to an AxisTool if possible, returns None otherwise

fn axis_tool_mut(&mut self) -> Option<&mut dyn AxisTool>

Upgrade the tool to an AxisTool if possible, returns None otherwise

fn spindle_tool(&self) -> Option<&dyn SpindleTool>

Upgrade the tool to an SpindleTool if possible, returns None otherwise

fn spindle_tool_mut(&mut self) -> Option<&mut dyn SpindleTool>

Upgrade the tool to an SpindleTool if possible, returns None otherwise

fn get_type_name(&self) -> &str

Returns the type name of the tool

Implementors

impl Tool for AxialJoint

impl Tool for AxisTongs

impl Tool for NoTool

impl Tool for PencilTool

impl Tool for Tongs