RigsofRods
Soft-body Physics Simulation
Modules | Data Structures | Typedefs | Enumerations | Functions | Variables
Gfx

Visual-only objects or visual couterparts to Gameplay objects. More...

+ Collaboration diagram for Gfx:

Modules

 Camera
 Camera control and logic.
 
 Hydrax
 Nice looking water, originally a 3rd party component.
 
 Particle
 Customizations of OGRE particle system: visuals + game logic.
 
 Flex
 Meshes deforming in real time: flexbodies, wings, wheels, cab mesh.
 

Data Structures

class  RoR::DustPool
 
class  RoR::GfxEnvmap
 A dynamic environment probe; Creates a cubemap with realtime reflections around specified point. More...
 
class  RoR::GfxActor
 
struct  RoR::PropAnim
 
struct  RoR::Prop
 A mesh attached to vehicle frame via 3 nodes. More...
 
struct  RoR::VideoCamera
 An Ogre::Camera mounted on the actor and rendering into either in-scene texture or external window. More...
 
struct  RoR::NodeGfx
 Gfx attributes/state of a softbody node. More...
 
struct  RoR::BeamGfx
 Visuals of softbody beam (beam_t struct); Partially updated along with SimBuffer. More...
 
struct  RoR::WheelGfx
 
struct  RoR::AirbrakeGfx
 
struct  RoR::FlareMaterial
 
class  RoR::GfxScene
 Provides a 3D graphical representation of the simulation Idea: simulation runs at it's own constant rate, scene updates and rendering run asynchronously. More...
 
class  RoR::HydraxWater
 
class  RoR::IWater
 < TODO: Mixed gfx+physics (waves) - must be separated ~ only_a_ptr, 02/2018 More...
 
class  RoR::MovableText
 
class  RoR::Renderdash
 'renderdash' is a name of a classic Render-To-Texture animated material with gauges and other dashboard info. More...
 
struct  RoR::PSSM_Shadows_Data
 
class  RoR::ShadowManager
 
class  RoR::Skidmark
 
class  RoR::SkyXManager
 
class  RoR::Water
 
class  MeshObject
 

Typedefs

typedef BitMask64_t RoR::PropAnimFlag_t
 
typedef BitMask_t RoR::PropAnimMode_t
 
typedef int RoR::CameraMode_t
 

Enumerations

enum  RoR::VideoCamState { RoR::VideoCamState::VCSTATE_INVALID, RoR::VideoCamState::VCSTATE_DISABLED, RoR::VideoCamState::VCSTATE_ENABLED_OFFLINE, RoR::VideoCamState::VCSTATE_ENABLED_ONLINE }
 
enum  RoR::DebugViewType {
  RoR::DebugViewType::DEBUGVIEW_NONE, RoR::DebugViewType::DEBUGVIEW_SKELETON, RoR::DebugViewType::DEBUGVIEW_NODES, RoR::DebugViewType::DEBUGVIEW_BEAMS,
  RoR::DebugViewType::DEBUGVIEW_WHEELS, RoR::DebugViewType::DEBUGVIEW_SHOCKS, RoR::DebugViewType::DEBUGVIEW_ROTATORS, RoR::DebugViewType::DEBUGVIEW_SLIDENODES,
  RoR::DebugViewType::DEBUGVIEW_SUBMESH
}
 
enum  RoR::WheelSide : char { RoR::WheelSide::INVALID = 'n', RoR::WheelSide::RIGHT = 'r', RoR::WheelSide::LEFT = 'l' }
 Used by rig-def/addonpart/tuneup formats to specify wheel rim mesh orientation. More...
 
enum  RoR::ShifterPropAnim {
  RoR::SHIFTER_INVALID = 0, RoR::SHIFTERMAN1 = 1, RoR::SHIFTERMAN2 = 2, RoR::SHIFTERSEQ = 3,
  RoR::SHIFTERLIN = 4, RoR::AUTOSHIFTERLIN = 5
}
 < PropAnim::animOpt3 values for PROP_ANIM_FLAG_SHIFTER More...
 
enum  RoR::VideoCamType {
  RoR::VCTYPE_INVALID, RoR::VCTYPE_VIDEOCAM, RoR::VCTYPE_TRACKING_VIDEOCAM, RoR::VCTYPE_MIRROR,
  RoR::VCTYPE_MIRROR_PROP_LEFT, RoR::VCTYPE_MIRROR_PROP_RIGHT
}
 

Functions

void SaveImage (Ogre::TexturePtr TextureToSave, Ogre::String filename)
 Saves a texture to the disk. More...
 
void WriteToTexture (const Ogre::String &str, Ogre::TexturePtr destTexture, Ogre::Box destRectangle, Ogre::Font *font, const Ogre::ColourValue &color, int fontSize=15, int fontDPI=400, char justify='l', bool wordwrap=true)
 Writes a string onto a texture. More...
 

Variables

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_AIRSPEED = BITMASK64(1)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_VVI = BITMASK64(2)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_ALTIMETER = BITMASK64(3)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_AOA = BITMASK64(4)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_FLAP = BITMASK64(5)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_AIRBRAKE = BITMASK64(6)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_ROLL = BITMASK64(7)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_PITCH = BITMASK64(8)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_THROTTLE = BITMASK64(9)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_RPM = BITMASK64(10)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_ACCEL = BITMASK64(11)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_BRAKE = BITMASK64(12)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_CLUTCH = BITMASK64(13)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_TACHO = BITMASK64(14)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_SPEEDO = BITMASK64(15)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_PBRAKE = BITMASK64(16)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_TURBO = BITMASK64(17)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_SHIFTER = BITMASK64(18)
 'shifterman1, shifterman2, sequential, shifterlin, autoshifterlin'; animOpt3: see RoR::ShifterPropAnim More...
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_AETORQUE = BITMASK64(19)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_AEPITCH = BITMASK64(20)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_AESTATUS = BITMASK64(21)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_TORQUE = BITMASK64(22)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_HEADING = BITMASK64(23)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_DIFFLOCK = BITMASK64(24)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_STEERING = BITMASK64(25)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_EVENT = BITMASK64(26)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_AILERONS = BITMASK64(27)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_ARUDDER = BITMASK64(28)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_BRUDDER = BITMASK64(29)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_BTHROTTLE = BITMASK64(30)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_PERMANENT = BITMASK64(31)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_ELEVATORS = BITMASK64(32)
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_DASHBOARD = BITMASK64(33)
 Used with dashboard system inputs, see enum DashData in file DashBoardManager.h. More...
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_SIGNALSTALK = BITMASK64(34)
 Turn indicator stalk position (-1=left, 0=off, 1=right) More...
 
const PropAnimFlag_t RoR::PROP_ANIM_FLAG_GEAR = BITMASK64(35)
 'gearreverse' (animOpt3=-1), 'gearneutral' (animOpt3=0), 'gear#' (animOpt3=#) More...
 
const PropAnimMode_t RoR::PROP_ANIM_MODE_ROTA_X = BITMASK(1)
 
const PropAnimMode_t RoR::PROP_ANIM_MODE_ROTA_Y = BITMASK(2)
 
const PropAnimMode_t RoR::PROP_ANIM_MODE_ROTA_Z = BITMASK(3)
 
const PropAnimMode_t RoR::PROP_ANIM_MODE_OFFSET_X = BITMASK(4)
 
const PropAnimMode_t RoR::PROP_ANIM_MODE_OFFSET_Y = BITMASK(5)
 
const PropAnimMode_t RoR::PROP_ANIM_MODE_OFFSET_Z = BITMASK(6)
 
const PropAnimMode_t RoR::PROP_ANIM_MODE_AUTOANIMATE = BITMASK(7)
 
const PropAnimMode_t RoR::PROP_ANIM_MODE_NOFLIP = BITMASK(8)
 
const PropAnimMode_t RoR::PROP_ANIM_MODE_BOUNCE = BITMASK(9)
 
static CameraMode_t RoR::CAMERA_MODE_ALWAYS_HIDDEN = -3
 
static CameraMode_t RoR::CAMERA_MODE_ALWAYS_VISIBLE = -2
 
static CameraMode_t RoR::CAMERA_MODE_3RDPERSON_ONLY = -1
 

Detailed Description

Visual-only objects or visual couterparts to Gameplay objects.

Typedef Documentation

◆ CameraMode_t

typedef int RoR::CameraMode_t

Definition at line 123 of file GfxData.h.

◆ PropAnimFlag_t

Definition at line 42 of file GfxData.h.

◆ PropAnimMode_t

Definition at line 80 of file GfxData.h.

Enumeration Type Documentation

◆ DebugViewType

enum RoR::DebugViewType
strong
Enumerator
DEBUGVIEW_NONE 
DEBUGVIEW_SKELETON 
DEBUGVIEW_NODES 
DEBUGVIEW_BEAMS 
DEBUGVIEW_WHEELS 
DEBUGVIEW_SHOCKS 
DEBUGVIEW_ROTATORS 
DEBUGVIEW_SLIDENODES 
DEBUGVIEW_SUBMESH 

Definition at line 101 of file GfxData.h.

◆ ShifterPropAnim

< PropAnim::animOpt3 values for PROP_ANIM_FLAG_SHIFTER

Enumerator
SHIFTER_INVALID 
SHIFTERMAN1 
SHIFTERMAN2 
SHIFTERSEQ 
SHIFTERLIN 
AUTOSHIFTERLIN 

Definition at line 128 of file GfxData.h.

◆ VideoCamState

enum RoR::VideoCamState
strong
Enumerator
VCSTATE_INVALID 
VCSTATE_DISABLED 
VCSTATE_ENABLED_OFFLINE 
VCSTATE_ENABLED_ONLINE 

Definition at line 93 of file GfxData.h.

◆ VideoCamType

Enumerator
VCTYPE_INVALID 
VCTYPE_VIDEOCAM 
VCTYPE_TRACKING_VIDEOCAM 
VCTYPE_MIRROR 
VCTYPE_MIRROR_PROP_LEFT 

The classic 'special prop/rear view mirror'.

VCTYPE_MIRROR_PROP_RIGHT 

The classic 'special prop/rear view mirror'.

Definition at line 219 of file GfxData.h.

◆ WheelSide

enum RoR::WheelSide : char
strong

Used by rig-def/addonpart/tuneup formats to specify wheel rim mesh orientation.

Enumerator
INVALID 
RIGHT 
LEFT 

Definition at line 115 of file GfxData.h.

Function Documentation

◆ SaveImage()

void SaveImage ( Ogre::TexturePtr  TextureToSave,
Ogre::String  filename 
)

Saves a texture to the disk.

Parameters
TextureToSaveThe texture to save.
filenameThe file-name.

◆ WriteToTexture()

void WriteToTexture ( const Ogre::String &  str,
Ogre::TexturePtr  destTexture,
Ogre::Box  destRectangle,
Ogre::Font *  font,
const Ogre::ColourValue &  color,
int  fontSize = 15,
int  fontDPI = 400,
char  justify = 'l',
bool  wordwrap = true 
)

Writes a string onto a texture.

Parameters
strThe string to write onto the texture.
destTextureThe texture to write the string on.
destRectangleThe Area to write in.
fontA pointer to the font to use.
colorThe color of the text.
fontSizeThe size of the font in points.
fontDPIThe resolution of the font in dpi.
justify'l' = left aligned, 'c' = centered, 'r' = right aligned.
wordwrapif true the line will only be wrapped after a word.

Variable Documentation

◆ CAMERA_MODE_3RDPERSON_ONLY

CameraMode_t RoR::CAMERA_MODE_3RDPERSON_ONLY = -1
static

Definition at line 126 of file GfxData.h.

◆ CAMERA_MODE_ALWAYS_HIDDEN

CameraMode_t RoR::CAMERA_MODE_ALWAYS_HIDDEN = -3
static

Definition at line 124 of file GfxData.h.

◆ CAMERA_MODE_ALWAYS_VISIBLE

CameraMode_t RoR::CAMERA_MODE_ALWAYS_VISIBLE = -2
static

Definition at line 125 of file GfxData.h.

◆ PROP_ANIM_FLAG_ACCEL

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_ACCEL = BITMASK64(11)

Definition at line 54 of file GfxData.h.

◆ PROP_ANIM_FLAG_AEPITCH

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_AEPITCH = BITMASK64(20)

Definition at line 63 of file GfxData.h.

◆ PROP_ANIM_FLAG_AESTATUS

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_AESTATUS = BITMASK64(21)

Definition at line 64 of file GfxData.h.

◆ PROP_ANIM_FLAG_AETORQUE

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_AETORQUE = BITMASK64(19)

Definition at line 62 of file GfxData.h.

◆ PROP_ANIM_FLAG_AILERONS

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_AILERONS = BITMASK64(27)

Definition at line 70 of file GfxData.h.

◆ PROP_ANIM_FLAG_AIRBRAKE

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_AIRBRAKE = BITMASK64(6)

Definition at line 49 of file GfxData.h.

◆ PROP_ANIM_FLAG_AIRSPEED

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_AIRSPEED = BITMASK64(1)

Definition at line 44 of file GfxData.h.

◆ PROP_ANIM_FLAG_ALTIMETER

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_ALTIMETER = BITMASK64(3)

Definition at line 46 of file GfxData.h.

◆ PROP_ANIM_FLAG_AOA

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_AOA = BITMASK64(4)

Definition at line 47 of file GfxData.h.

◆ PROP_ANIM_FLAG_ARUDDER

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_ARUDDER = BITMASK64(28)

Definition at line 71 of file GfxData.h.

◆ PROP_ANIM_FLAG_BRAKE

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_BRAKE = BITMASK64(12)

Definition at line 55 of file GfxData.h.

◆ PROP_ANIM_FLAG_BRUDDER

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_BRUDDER = BITMASK64(29)

Definition at line 72 of file GfxData.h.

◆ PROP_ANIM_FLAG_BTHROTTLE

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_BTHROTTLE = BITMASK64(30)

Definition at line 73 of file GfxData.h.

◆ PROP_ANIM_FLAG_CLUTCH

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_CLUTCH = BITMASK64(13)

Definition at line 56 of file GfxData.h.

◆ PROP_ANIM_FLAG_DASHBOARD

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_DASHBOARD = BITMASK64(33)

Used with dashboard system inputs, see enum DashData in file DashBoardManager.h.

Definition at line 76 of file GfxData.h.

◆ PROP_ANIM_FLAG_DIFFLOCK

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_DIFFLOCK = BITMASK64(24)

Definition at line 67 of file GfxData.h.

◆ PROP_ANIM_FLAG_ELEVATORS

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_ELEVATORS = BITMASK64(32)

Definition at line 75 of file GfxData.h.

◆ PROP_ANIM_FLAG_EVENT

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_EVENT = BITMASK64(26)

Definition at line 69 of file GfxData.h.

◆ PROP_ANIM_FLAG_FLAP

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_FLAP = BITMASK64(5)

Definition at line 48 of file GfxData.h.

◆ PROP_ANIM_FLAG_GEAR

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_GEAR = BITMASK64(35)

'gearreverse' (animOpt3=-1), 'gearneutral' (animOpt3=0), 'gear#' (animOpt3=#)

Definition at line 78 of file GfxData.h.

◆ PROP_ANIM_FLAG_HEADING

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_HEADING = BITMASK64(23)

Definition at line 66 of file GfxData.h.

◆ PROP_ANIM_FLAG_PBRAKE

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_PBRAKE = BITMASK64(16)

Definition at line 59 of file GfxData.h.

◆ PROP_ANIM_FLAG_PERMANENT

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_PERMANENT = BITMASK64(31)

Definition at line 74 of file GfxData.h.

◆ PROP_ANIM_FLAG_PITCH

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_PITCH = BITMASK64(8)

Definition at line 51 of file GfxData.h.

◆ PROP_ANIM_FLAG_ROLL

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_ROLL = BITMASK64(7)

Definition at line 50 of file GfxData.h.

◆ PROP_ANIM_FLAG_RPM

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_RPM = BITMASK64(10)

Definition at line 53 of file GfxData.h.

◆ PROP_ANIM_FLAG_SHIFTER

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_SHIFTER = BITMASK64(18)

'shifterman1, shifterman2, sequential, shifterlin, autoshifterlin'; animOpt3: see RoR::ShifterPropAnim

Definition at line 61 of file GfxData.h.

◆ PROP_ANIM_FLAG_SIGNALSTALK

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_SIGNALSTALK = BITMASK64(34)

Turn indicator stalk position (-1=left, 0=off, 1=right)

Definition at line 77 of file GfxData.h.

◆ PROP_ANIM_FLAG_SPEEDO

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_SPEEDO = BITMASK64(15)

Definition at line 58 of file GfxData.h.

◆ PROP_ANIM_FLAG_STEERING

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_STEERING = BITMASK64(25)

Definition at line 68 of file GfxData.h.

◆ PROP_ANIM_FLAG_TACHO

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_TACHO = BITMASK64(14)

Definition at line 57 of file GfxData.h.

◆ PROP_ANIM_FLAG_THROTTLE

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_THROTTLE = BITMASK64(9)

Definition at line 52 of file GfxData.h.

◆ PROP_ANIM_FLAG_TORQUE

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_TORQUE = BITMASK64(22)

Definition at line 65 of file GfxData.h.

◆ PROP_ANIM_FLAG_TURBO

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_TURBO = BITMASK64(17)

Definition at line 60 of file GfxData.h.

◆ PROP_ANIM_FLAG_VVI

const PropAnimFlag_t RoR::PROP_ANIM_FLAG_VVI = BITMASK64(2)

Definition at line 45 of file GfxData.h.

◆ PROP_ANIM_MODE_AUTOANIMATE

const PropAnimMode_t RoR::PROP_ANIM_MODE_AUTOANIMATE = BITMASK(7)

Definition at line 88 of file GfxData.h.

◆ PROP_ANIM_MODE_BOUNCE

const PropAnimMode_t RoR::PROP_ANIM_MODE_BOUNCE = BITMASK(9)

Definition at line 90 of file GfxData.h.

◆ PROP_ANIM_MODE_NOFLIP

const PropAnimMode_t RoR::PROP_ANIM_MODE_NOFLIP = BITMASK(8)

Definition at line 89 of file GfxData.h.

◆ PROP_ANIM_MODE_OFFSET_X

const PropAnimMode_t RoR::PROP_ANIM_MODE_OFFSET_X = BITMASK(4)

Definition at line 85 of file GfxData.h.

◆ PROP_ANIM_MODE_OFFSET_Y

const PropAnimMode_t RoR::PROP_ANIM_MODE_OFFSET_Y = BITMASK(5)

Definition at line 86 of file GfxData.h.

◆ PROP_ANIM_MODE_OFFSET_Z

const PropAnimMode_t RoR::PROP_ANIM_MODE_OFFSET_Z = BITMASK(6)

Definition at line 87 of file GfxData.h.

◆ PROP_ANIM_MODE_ROTA_X

const PropAnimMode_t RoR::PROP_ANIM_MODE_ROTA_X = BITMASK(1)

Definition at line 82 of file GfxData.h.

◆ PROP_ANIM_MODE_ROTA_Y

const PropAnimMode_t RoR::PROP_ANIM_MODE_ROTA_Y = BITMASK(2)

Definition at line 83 of file GfxData.h.

◆ PROP_ANIM_MODE_ROTA_Z

const PropAnimMode_t RoR::PROP_ANIM_MODE_ROTA_Z = BITMASK(3)

Definition at line 84 of file GfxData.h.