Struct mjsFrame_ 

pub struct mjsFrame_ { /* private fields */ }

Implementations

impl mjsFrame_

pub fn info(&self) -> &str

Return the message appended to compiler errors.

Panics

Panics if it contains invalid UTF-8.

pub fn set_info(&mut self, info: &str)

Set the message appended to compiler errors.

Panics

When the info contains ‘\0’ characters, a panic occurs.

impl mjsFrame_

pub fn add_body(&mut self) -> &mut MjsBody

Add and return a child MjsBody.

Delegates to Self::try_add_body and panics on failure.

Panics

Panics if MuJoCo fails to allocate the element.

pub fn try_add_body(&mut self) -> Result<&mut MjsBody, MjEditError>

Fallible version of Self::add_body.

Errors

Returns MjEditError::AllocationFailed when MuJoCo fails to allocate the element.

pub fn add_site(&mut self) -> &mut MjsSite

Add and return a child MjsSite.

Delegates to Self::try_add_site and panics on failure.

Panics

Panics if MuJoCo fails to allocate the element.

pub fn try_add_site(&mut self) -> Result<&mut MjsSite, MjEditError>

Fallible version of Self::add_site.

Errors

Returns MjEditError::AllocationFailed when MuJoCo fails to allocate the element.

pub fn add_joint(&mut self) -> &mut MjsJoint

Add and return a child MjsJoint.

Delegates to Self::try_add_joint and panics on failure.

Panics

Panics if MuJoCo fails to allocate the element.

pub fn try_add_joint(&mut self) -> Result<&mut MjsJoint, MjEditError>

Fallible version of Self::add_joint.

Errors

Returns MjEditError::AllocationFailed when MuJoCo fails to allocate the element.

pub fn add_geom(&mut self) -> &mut MjsGeom

Add and return a child MjsGeom.

Delegates to Self::try_add_geom and panics on failure.

Panics

Panics if MuJoCo fails to allocate the element.

pub fn try_add_geom(&mut self) -> Result<&mut MjsGeom, MjEditError>

Fallible version of Self::add_geom.

Errors

Returns MjEditError::AllocationFailed when MuJoCo fails to allocate the element.

pub fn add_camera(&mut self) -> &mut MjsCamera

Add and return a child MjsCamera.

Delegates to Self::try_add_camera and panics on failure.

Panics

Panics if MuJoCo fails to allocate the element.

pub fn try_add_camera(&mut self) -> Result<&mut MjsCamera, MjEditError>

Fallible version of Self::add_camera.

Errors

Returns MjEditError::AllocationFailed when MuJoCo fails to allocate the element.

pub fn add_light(&mut self) -> &mut MjsLight

Add and return a child MjsLight.

Delegates to Self::try_add_light and panics on failure.

Panics

Panics if MuJoCo fails to allocate the element.

pub fn try_add_light(&mut self) -> Result<&mut MjsLight, MjEditError>

Fallible version of Self::add_light.

Errors

Returns MjEditError::AllocationFailed when MuJoCo fails to allocate the element.

pub fn pos(&self) -> &[f64; 3]

Return an immutable reference to frame position.

pub fn pos_mut(&mut self) -> &mut [f64; 3]

Return a mutable reference to frame position.

pub fn quat(&self) -> &[f64; 4]

Return an immutable reference to frame orientation.

pub fn quat_mut(&mut self) -> &mut [f64; 4]

Return a mutable reference to frame orientation.

pub fn alt(&self) -> &MjsOrientation

Return an immutable reference to alternative orientation.

pub fn alt_mut(&mut self) -> &mut MjsOrientation

Return a mutable reference to alternative orientation.

pub fn with_pos(&mut self, value: [f64; 3]) -> &mut Self

Builder method for setting frame position.

pub fn with_quat(&mut self, value: [f64; 4]) -> &mut Self

Builder method for setting frame orientation.

pub fn with_alt(&mut self, value: MjsOrientation) -> &mut Self

Builder method for setting alternative orientation.

pub fn childclass(&self) -> &str

Return childclass name.

Panics

Panics if the stored string is not valid UTF-8, which can only happen on internal memory corruption – MuJoCo only uses ASCII values.

pub fn set_childclass(&mut self, value: &str)

Set childclass name.

Panics

When the value contains ‘\0’ characters, a panic occurs.

pub fn with_childclass(&mut self, value: &str) -> &mut Self

Builder method for setting childclass name.

Panics

When the value contains ‘\0’ characters, a panic occurs.

pub fn add_frame(&mut self) -> &mut MjsFrame

Add and return a child frame.

Delegates to Self::try_add_frame and panics if allocation fails.

Panics

Panics if MuJoCo fails to allocate the frame.

pub fn try_add_frame(&mut self) -> Result<&mut MjsFrame, MjEditError>

Fallible version of Self::add_frame.

Errors

Returns MjEditError::AllocationFailed when MuJoCo fails to allocate the frame, instead of panicking.

Trait Implementations

impl Debug for mjsFrame_

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

Formats the value using the given formatter.