Struct RenderContext 

pub struct RenderContext {
    pub world: Option<String>,
    pub proto: Option<String>,
    pub project_path: Option<String>,
    pub webots_version: Option<RenderWebotsVersion>,
    pub webots_home: Option<String>,
    pub temporary_files_path: Option<String>,
    pub os: Option<String>,
    pub id: Option<String>,
    pub coordinate_system: Option<String>,
}

Fields

world: Option<String>

proto: Option<String>

project_path: Option<String>

webots_version: Option<RenderWebotsVersion>

webots_home: Option<String>

temporary_files_path: Option<String>

os: Option<String>

id: Option<String>

coordinate_system: Option<String>

Implementations

impl RenderContext

pub fn with_world(self, value: impl Into<String>) -> RenderContext

Sets the world field of this struct.

Examples found in repository

examples/workflow.rs (line 42)

fn main() -> Result<(), Box<dyn Error>> {
    let input = r#"#VRML_SIM R2025a utf8

PROTO ContextAwareBox [
  field SFInt32 count 2
  field SFString label "default-label"
]
{
  Group {
    children [
      WorldInfo { title "%<= fields.label.value >%|%<= fields.label.defaultValue >%|%<= context.os >%" }
      %< for (let i = 0; i < fields.count.value; ++i) { >%
        Transform {
          translation %<= i >% 0 0
          children [ Box { size 0.5 0.5 0.5 } ]
        }
      %< } >%
    ]
  }
}
"#;

    let document: Proto = input.parse()?;
    let diagnostics = document.validate()?;
    println!("diagnostics: {}", diagnostics.len());

    let mut field_overrides = HashMap::new();
    field_overrides.insert("count".to_string(), TemplateField::SFInt32(3));
    field_overrides.insert(
        "label".to_string(),
        TemplateField::SFString("override-label".to_string()),
    );

    let context = RenderContext::default()
        .with_os("linux")
        .with_world("/workspace/worlds/example.wbt")
        .with_webots_version(RenderWebotsVersion::new(
            "R2025a".to_string(),
            "0".to_string(),
        ));

    let options = RenderOptions::default()
        .with_field_overrides(field_overrides)
        .with_context(context);

    let rendered = document.render(&options)?;
    println!("{rendered}");

    Ok(())
}

pub fn with_proto(self, value: impl Into<String>) -> RenderContext

Sets the proto field of this struct.

pub fn with_project_path(self, value: impl Into<String>) -> RenderContext

Sets the project_path field of this struct.

pub fn with_webots_version( self, value: impl Into<RenderWebotsVersion>, ) -> RenderContext

Sets the webots_version field of this struct.

Examples found in repository

examples/workflow.rs (lines 43-46)

fn main() -> Result<(), Box<dyn Error>> {
    let input = r#"#VRML_SIM R2025a utf8

PROTO ContextAwareBox [
  field SFInt32 count 2
  field SFString label "default-label"
]
{
  Group {
    children [
      WorldInfo { title "%<= fields.label.value >%|%<= fields.label.defaultValue >%|%<= context.os >%" }
      %< for (let i = 0; i < fields.count.value; ++i) { >%
        Transform {
          translation %<= i >% 0 0
          children [ Box { size 0.5 0.5 0.5 } ]
        }
      %< } >%
    ]
  }
}
"#;

    let document: Proto = input.parse()?;
    let diagnostics = document.validate()?;
    println!("diagnostics: {}", diagnostics.len());

    let mut field_overrides = HashMap::new();
    field_overrides.insert("count".to_string(), TemplateField::SFInt32(3));
    field_overrides.insert(
        "label".to_string(),
        TemplateField::SFString("override-label".to_string()),
    );

    let context = RenderContext::default()
        .with_os("linux")
        .with_world("/workspace/worlds/example.wbt")
        .with_webots_version(RenderWebotsVersion::new(
            "R2025a".to_string(),
            "0".to_string(),
        ));

    let options = RenderOptions::default()
        .with_field_overrides(field_overrides)
        .with_context(context);

    let rendered = document.render(&options)?;
    println!("{rendered}");

    Ok(())
}

pub fn with_webots_home(self, value: impl Into<String>) -> RenderContext

Sets the webots_home field of this struct.

pub fn with_temporary_files_path( self, value: impl Into<String>, ) -> RenderContext

Sets the temporary_files_path field of this struct.

pub fn with_os(self, value: impl Into<String>) -> RenderContext

Sets the os field of this struct.

Examples found in repository

examples/workflow.rs (line 41)

fn main() -> Result<(), Box<dyn Error>> {
    let input = r#"#VRML_SIM R2025a utf8

PROTO ContextAwareBox [
  field SFInt32 count 2
  field SFString label "default-label"
]
{
  Group {
    children [
      WorldInfo { title "%<= fields.label.value >%|%<= fields.label.defaultValue >%|%<= context.os >%" }
      %< for (let i = 0; i < fields.count.value; ++i) { >%
        Transform {
          translation %<= i >% 0 0
          children [ Box { size 0.5 0.5 0.5 } ]
        }
      %< } >%
    ]
  }
}
"#;

    let document: Proto = input.parse()?;
    let diagnostics = document.validate()?;
    println!("diagnostics: {}", diagnostics.len());

    let mut field_overrides = HashMap::new();
    field_overrides.insert("count".to_string(), TemplateField::SFInt32(3));
    field_overrides.insert(
        "label".to_string(),
        TemplateField::SFString("override-label".to_string()),
    );

    let context = RenderContext::default()
        .with_os("linux")
        .with_world("/workspace/worlds/example.wbt")
        .with_webots_version(RenderWebotsVersion::new(
            "R2025a".to_string(),
            "0".to_string(),
        ));

    let options = RenderOptions::default()
        .with_field_overrides(field_overrides)
        .with_context(context);

    let rendered = document.render(&options)?;
    println!("{rendered}");

    Ok(())
}

pub fn with_id(self, value: impl Into<String>) -> RenderContext

Sets the id field of this struct.

pub fn with_coordinate_system(self, value: impl Into<String>) -> RenderContext

Sets the coordinate_system field of this struct.

Trait Implementations

impl Clone for RenderContext

fn clone(&self) -> RenderContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RenderContext

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

Formats the value using the given formatter.

impl Default for RenderContext

fn default() -> RenderContext

Returns the “default value” for a type.