Skip to content

UMjSite

Represents a MuJoCo site element within Unreal Engine.

Sites are interesting locations on a body, used for sensor attachment, constraint definition, or visualization. This component mirrors the site element in MuJoCo XML.

Attribute Value
Kind Class
UE Macro UCLASS
Inherits UMjComponent
Blueprint Spawnable ✅ Yes

Properties

Public Properties

Property Type Description
Pos FVector
Quat FQuat
group int32
material FString
rgba FLinearColor
Type EMjSiteType The geometric shape type of the site.
MjClassName FString Optional MuJoCo class name to inherit defaults from (string fallback).
DefaultClass UMjDefault* Reference to a UMjDefault component for default class inheritance.
m_SiteView SiteView The runtime view of the MuJoCo site. Valid only after Bind() is called.

Pos

Override-enabled (bOverride_Pos)

  • Type: FVector
  • Editor: ✏️ EditAnywhere
  • Blueprint: 🔵 ReadWrite
  • Category: MuJoCo|MjSite|Spatial Pose

Quat

Override-enabled (bOverride_Quat)

  • Type: FQuat
  • Editor: ✏️ EditAnywhere
  • Blueprint: 🔵 ReadWrite
  • Category: MuJoCo|MjSite|Orientation

group

Override-enabled (bOverride_group)

  • Type: int32
  • Editor: ✏️ EditAnywhere
  • Blueprint: 🔵 ReadWrite
  • Category: MuJoCo|MjSite

material

Override-enabled (bOverride_material)

  • Type: FString
  • Editor: ✏️ EditAnywhere
  • Blueprint: 🔵 ReadWrite
  • Category: MuJoCo|MjSite

rgba

Override-enabled (bOverride_rgba)

  • Type: FLinearColor
  • Editor: ✏️ EditAnywhere
  • Blueprint: 🔵 ReadWrite
  • Category: MuJoCo|MjSite

Type

The geometric shape type of the site.

  • Type: EMjSiteType
  • Editor: ✏️ EditAnywhere
  • Blueprint: 🔵 ReadWrite
  • Category: MuJoCo|Site

MjClassName

Optional MuJoCo class name to inherit defaults from (string fallback).

  • Type: FString
  • Editor: ✏️ EditAnywhere
  • Blueprint: 🔵 ReadWrite
  • Category: MuJoCo|Site

DefaultClass

Reference to a UMjDefault component for default class inheritance.

  • Type: UMjDefault*
  • Editor: ✏️ EditAnywhere
  • Blueprint: 🔵 ReadWrite
  • Category: MuJoCo|Site

m_SiteView

The runtime view of the MuJoCo site. Valid only after Bind() is called.

Functions

Public Functions

General

Function Returns Description
ExportTo() void Exports properties to a MuJoCo spec site structure.
Bind() void Binds this component to the live MuJoCo simulation.
RegisterToSpec() void Registers this site to the MuJoCo spec.
ImportFromXml() void Imports properties from a MuJoCo XML node.
UMjSite() Default constructor.
GetMj() SiteView& Semantic accessor for raw MuJoCo data and helper methods.
ExportTo

Exports properties to a MuJoCo spec site structure.

  • Signature: ExportTo(mjsSite* Element, mjsDefault* def)
Bind

Binds this component to the live MuJoCo simulation.

  • Signature: Bind(mjModel* model, mjData* data, const FString& Prefix)
RegisterToSpec

Registers this site to the MuJoCo spec.

ImportFromXml

Imports properties from a MuJoCo XML node.

  • Signature: ImportFromXml(const class FXmlNode* Node, const struct FMjCompilerSettings& CompilerSettings)
UMjSite

Default constructor.

  • Signature: UMjSite()
GetMj

Semantic accessor for raw MuJoCo data and helper methods.