Struct MjsTuple 

pub struct MjsTuple { /* private fields */ }

MjsTuple specification. An opaque handle for the FFI type mjsTuple, reached through ffi.

Implementations

impl MjsTuple

pub fn ffi(&self) -> &mjsTuple

Returns the FFI struct that the handle stands on.

pub unsafe fn ffi_mut(&mut self) -> &mut mjsTuple

Returns the FFI struct that the handle stands on, mutably.

Safety

The caller must not exchange the contents of the struct with another element’s.

impl MjsTuple

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 MjsTuple

pub fn set_objtype(&mut self, value: &[MjtObj]) -> Result<(), MjEditError>

Set object types. Every value must be a real object type (an MjtObj below mjNOBJECT).

Errors

Returns MjEditError::InvalidParameter when any value is not a real object type (i.e. not below MjtObj::mjNOBJECT) (in that case nothing is written).

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

Splits the objname and put the split text as object names.

Panics

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

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

Appends objname as a single entry to object names.

Panics

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

pub fn objprm(&self) -> &[f64]

Return object parameters.

pub fn set_objprm(&mut self, value: &[f64])

Set object parameters.

Trait Implementations

impl Debug for MjsTuple

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

Formats the value using the given formatter.

impl SpecItem for MjsTuple

fn element_pointer(&self) -> *const mjsElement

Returns the mjsElement that MuJoCo keeps behind the item.

fn element_mut_pointer(&mut self) -> *mut mjsElement

Same as SpecItem::element_pointer, but with a mutable borrow and a mutable pointer.

fn name(&self) -> &str

Returns the item’s name.

fn set_name(&mut self, name: &str) -> Result<(), MjEditError>

Set a new name.

fn with_name(&mut self, name: &str) -> &mut Self

Builder style set a new name.

fn default(&self) -> Option<&MjsDefault>

Returns the used default, or None when the element carries no default class name.

fn id(&self) -> Option<usize>

Returns the numeric id for this element, or None when it has none yet (before compilation, for example).

fn set_default(&mut self, class_name: &str) -> Result<(), MjEditError>

Assign the item to a default class.

fn with_default(&mut self, class_name: &str) -> Result<&mut Self, MjEditError>

Builder style make the item inherit from a default class.

impl SpecObject for MjsTuple

const OBJ_TYPE: MjtObj = MjtObj::mjOBJ_TUPLE

The mjtObj discriminant passed to mjs_firstElement / mjs_firstChild.

unsafe fn from_element_as_ptr_mut(element: *mut mjsElement) -> *mut Self

Casts a raw *mut mjsElement to *mut Self.

unsafe fn delete(&mut self) -> Result<(), MjEditError>

Delete the element from the specification that holds it.