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

Enumerations
enum	RoR::PropAnimMode { RoR::PROP_ANIM_MODE_ROTA_X = BITMASK(1), RoR::PROP_ANIM_MODE_ROTA_Y = BITMASK(2), RoR::PROP_ANIM_MODE_ROTA_Z = BITMASK(3), RoR::PROP_ANIM_MODE_OFFSET_X = BITMASK(4), RoR::PROP_ANIM_MODE_OFFSET_Y = BITMASK(5), RoR::PROP_ANIM_MODE_OFFSET_Z = BITMASK(6), RoR::PROP_ANIM_MODE_AUTOANIMATE = BITMASK(7), RoR::PROP_ANIM_MODE_NOFLIP = BITMASK(8), RoR::PROP_ANIM_MODE_BOUNCE = BITMASK(9) }

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 }

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
PropAnimMode	RoR::operator\|= (PropAnimMode &dst, PropAnimMode const &arg)

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
static const BitMask64_t	RoR::PROP_ANIM_FLAG_AIRSPEED = BITMASK64(1)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_VVI = BITMASK64(2)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_ALTIMETER = BITMASK64(3)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_AOA = BITMASK64(4)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_FLAP = BITMASK64(5)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_AIRBRAKE = BITMASK64(6)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_ROLL = BITMASK64(7)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_PITCH = BITMASK64(8)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_THROTTLE = BITMASK64(9)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_RPM = BITMASK64(10)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_ACCEL = BITMASK64(11)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_BRAKE = BITMASK64(12)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_CLUTCH = BITMASK64(13)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_TACHO = BITMASK64(14)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_SPEEDO = BITMASK64(15)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_PBRAKE = BITMASK64(16)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_TURBO = BITMASK64(17)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_SHIFTER = BITMASK64(18)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_AETORQUE = BITMASK64(19)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_AEPITCH = BITMASK64(20)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_AESTATUS = BITMASK64(21)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_TORQUE = BITMASK64(22)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_HEADING = BITMASK64(23)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_DIFFLOCK = BITMASK64(24)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_STEERING = BITMASK64(25)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_EVENT = BITMASK64(26)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_AILERONS = BITMASK64(27)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_ARUDDER = BITMASK64(28)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_BRUDDER = BITMASK64(29)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_BTHROTTLE = BITMASK64(30)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_PERMANENT = BITMASK64(31)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_ELEVATORS = BITMASK64(32)

static const BitMask64_t	RoR::PROP_ANIM_FLAG_DASHBOARD = BITMASK64(33)
	Used with dashboard system inputs, see `enum DashData` in file DashBoardManager.h. More...

static const BitMask64_t	RoR::PROP_ANIM_FLAG_SIGNALSTALK = BITMASK64(34)
	Turn indicator stalk position (-1=left, 0=off, 1=right) More...

static const int	RoR::CAMERA_MODE_ALWAYS_HIDDEN = -3

static const int	RoR::CAMERA_MODE_ALWAYS_VISIBLE = -2

static const int	RoR::CAMERA_MODE_3RDPERSON_ONLY = -1

Detailed Description

Visual-only objects or visual couterparts to Gameplay objects.

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.

◆ PropAnimMode

enum RoR::PropAnimMode

Enumerator
PROP_ANIM_MODE_ROTA_X
PROP_ANIM_MODE_ROTA_Y
PROP_ANIM_MODE_ROTA_Z
PROP_ANIM_MODE_OFFSET_X
PROP_ANIM_MODE_OFFSET_Y
PROP_ANIM_MODE_OFFSET_Z
PROP_ANIM_MODE_AUTOANIMATE
PROP_ANIM_MODE_NOFLIP
PROP_ANIM_MODE_BOUNCE

Definition at line 78 of file GfxData.h.

◆ ShifterPropAnim

enum RoR::ShifterPropAnim

Enumerator
SHIFTER_INVALID
SHIFTERMAN1
SHIFTERMAN2
SHIFTERSEQ
SHIFTERLIN

Definition at line 127 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

enum RoR::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 214 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

◆ operator|=()

PropAnimMode RoR::operator\|=	(	PropAnimMode &	dst,
		PropAnimMode const &	arg
	)

inline

Definition at line 91 of file GfxData.h.

◆ SaveImage()

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

Saves a texture to the disk.

Parameters

TextureToSave	The texture to save.
filename	The 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

str	The string to write onto the texture.
destTexture	The texture to write the string on.
destRectangle	The Area to write in.
font	A pointer to the font to use.
color	The color of the text.
fontSize	The size of the font in points.
fontDPI	The resolution of the font in dpi.
justify	'l' = left aligned, 'c' = centered, 'r' = right aligned.
wordwrap	if true the line will only be wrapped after a word.

Variable Documentation

◆ CAMERA_MODE_3RDPERSON_ONLY

const int RoR::CAMERA_MODE_3RDPERSON_ONLY = -1

static

Definition at line 125 of file GfxData.h.

◆ CAMERA_MODE_ALWAYS_HIDDEN

const int RoR::CAMERA_MODE_ALWAYS_HIDDEN = -3

static

Definition at line 123 of file GfxData.h.

◆ CAMERA_MODE_ALWAYS_VISIBLE

const int RoR::CAMERA_MODE_ALWAYS_VISIBLE = -2

static

Definition at line 124 of file GfxData.h.

◆ PROP_ANIM_FLAG_ACCEL

const BitMask64_t RoR::PROP_ANIM_FLAG_ACCEL = BITMASK64(11)

static

Definition at line 53 of file GfxData.h.

◆ PROP_ANIM_FLAG_AEPITCH

const BitMask64_t RoR::PROP_ANIM_FLAG_AEPITCH = BITMASK64(20)

static

Definition at line 62 of file GfxData.h.

◆ PROP_ANIM_FLAG_AESTATUS

const BitMask64_t RoR::PROP_ANIM_FLAG_AESTATUS = BITMASK64(21)

static

Definition at line 63 of file GfxData.h.

◆ PROP_ANIM_FLAG_AETORQUE

const BitMask64_t RoR::PROP_ANIM_FLAG_AETORQUE = BITMASK64(19)

static

Definition at line 61 of file GfxData.h.

◆ PROP_ANIM_FLAG_AILERONS

const BitMask64_t RoR::PROP_ANIM_FLAG_AILERONS = BITMASK64(27)

static

Definition at line 69 of file GfxData.h.

◆ PROP_ANIM_FLAG_AIRBRAKE

const BitMask64_t RoR::PROP_ANIM_FLAG_AIRBRAKE = BITMASK64(6)

static

Definition at line 48 of file GfxData.h.

◆ PROP_ANIM_FLAG_AIRSPEED

const BitMask64_t RoR::PROP_ANIM_FLAG_AIRSPEED = BITMASK64(1)

static

Definition at line 43 of file GfxData.h.

◆ PROP_ANIM_FLAG_ALTIMETER

const BitMask64_t RoR::PROP_ANIM_FLAG_ALTIMETER = BITMASK64(3)

static

Definition at line 45 of file GfxData.h.

◆ PROP_ANIM_FLAG_AOA

const BitMask64_t RoR::PROP_ANIM_FLAG_AOA = BITMASK64(4)

static

Definition at line 46 of file GfxData.h.

◆ PROP_ANIM_FLAG_ARUDDER

const BitMask64_t RoR::PROP_ANIM_FLAG_ARUDDER = BITMASK64(28)

static

Definition at line 70 of file GfxData.h.

◆ PROP_ANIM_FLAG_BRAKE

const BitMask64_t RoR::PROP_ANIM_FLAG_BRAKE = BITMASK64(12)

static

Definition at line 54 of file GfxData.h.

◆ PROP_ANIM_FLAG_BRUDDER

const BitMask64_t RoR::PROP_ANIM_FLAG_BRUDDER = BITMASK64(29)

static

Definition at line 71 of file GfxData.h.

◆ PROP_ANIM_FLAG_BTHROTTLE

const BitMask64_t RoR::PROP_ANIM_FLAG_BTHROTTLE = BITMASK64(30)

static

Definition at line 72 of file GfxData.h.

◆ PROP_ANIM_FLAG_CLUTCH

const BitMask64_t RoR::PROP_ANIM_FLAG_CLUTCH = BITMASK64(13)

static

Definition at line 55 of file GfxData.h.

◆ PROP_ANIM_FLAG_DASHBOARD

const BitMask64_t RoR::PROP_ANIM_FLAG_DASHBOARD = BITMASK64(33)

static

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

Definition at line 75 of file GfxData.h.

◆ PROP_ANIM_FLAG_DIFFLOCK

const BitMask64_t RoR::PROP_ANIM_FLAG_DIFFLOCK = BITMASK64(24)

static

Definition at line 66 of file GfxData.h.

◆ PROP_ANIM_FLAG_ELEVATORS

const BitMask64_t RoR::PROP_ANIM_FLAG_ELEVATORS = BITMASK64(32)

static

Definition at line 74 of file GfxData.h.

◆ PROP_ANIM_FLAG_EVENT

const BitMask64_t RoR::PROP_ANIM_FLAG_EVENT = BITMASK64(26)

static

Definition at line 68 of file GfxData.h.

◆ PROP_ANIM_FLAG_FLAP

const BitMask64_t RoR::PROP_ANIM_FLAG_FLAP = BITMASK64(5)

static

Definition at line 47 of file GfxData.h.

◆ PROP_ANIM_FLAG_HEADING

const BitMask64_t RoR::PROP_ANIM_FLAG_HEADING = BITMASK64(23)

static

Definition at line 65 of file GfxData.h.

◆ PROP_ANIM_FLAG_PBRAKE

const BitMask64_t RoR::PROP_ANIM_FLAG_PBRAKE = BITMASK64(16)

static

Definition at line 58 of file GfxData.h.

◆ PROP_ANIM_FLAG_PERMANENT

const BitMask64_t RoR::PROP_ANIM_FLAG_PERMANENT = BITMASK64(31)

static

Definition at line 73 of file GfxData.h.

◆ PROP_ANIM_FLAG_PITCH

const BitMask64_t RoR::PROP_ANIM_FLAG_PITCH = BITMASK64(8)

static

Definition at line 50 of file GfxData.h.

◆ PROP_ANIM_FLAG_ROLL

const BitMask64_t RoR::PROP_ANIM_FLAG_ROLL = BITMASK64(7)

static

Definition at line 49 of file GfxData.h.

◆ PROP_ANIM_FLAG_RPM

const BitMask64_t RoR::PROP_ANIM_FLAG_RPM = BITMASK64(10)

static

Definition at line 52 of file GfxData.h.

◆ PROP_ANIM_FLAG_SHIFTER

const BitMask64_t RoR::PROP_ANIM_FLAG_SHIFTER = BITMASK64(18)

static

Definition at line 60 of file GfxData.h.

◆ PROP_ANIM_FLAG_SIGNALSTALK

const BitMask64_t RoR::PROP_ANIM_FLAG_SIGNALSTALK = BITMASK64(34)

static

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

Definition at line 76 of file GfxData.h.

◆ PROP_ANIM_FLAG_SPEEDO

const BitMask64_t RoR::PROP_ANIM_FLAG_SPEEDO = BITMASK64(15)

static

Definition at line 57 of file GfxData.h.

◆ PROP_ANIM_FLAG_STEERING

const BitMask64_t RoR::PROP_ANIM_FLAG_STEERING = BITMASK64(25)

static

Definition at line 67 of file GfxData.h.

◆ PROP_ANIM_FLAG_TACHO

const BitMask64_t RoR::PROP_ANIM_FLAG_TACHO = BITMASK64(14)

static

Definition at line 56 of file GfxData.h.

◆ PROP_ANIM_FLAG_THROTTLE

const BitMask64_t RoR::PROP_ANIM_FLAG_THROTTLE = BITMASK64(9)

static

Definition at line 51 of file GfxData.h.

◆ PROP_ANIM_FLAG_TORQUE

const BitMask64_t RoR::PROP_ANIM_FLAG_TORQUE = BITMASK64(22)

static

Definition at line 64 of file GfxData.h.

◆ PROP_ANIM_FLAG_TURBO

const BitMask64_t RoR::PROP_ANIM_FLAG_TURBO = BITMASK64(17)

static

Definition at line 59 of file GfxData.h.

◆ PROP_ANIM_FLAG_VVI

const BitMask64_t RoR::PROP_ANIM_FLAG_VVI = BITMASK64(2)

static

Definition at line 44 of file GfxData.h.

Modules

Data Structures

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation

◆ DebugViewType

◆ PropAnimMode

◆ ShifterPropAnim

◆ VideoCamState

◆ VideoCamType

◆ WheelSide

Function Documentation

◆ operator|=()

◆ SaveImage()

◆ WriteToTexture()

Variable Documentation

◆ CAMERA_MODE_3RDPERSON_ONLY

◆ CAMERA_MODE_ALWAYS_HIDDEN

◆ CAMERA_MODE_ALWAYS_VISIBLE

◆ PROP_ANIM_FLAG_ACCEL

◆ PROP_ANIM_FLAG_AEPITCH

◆ PROP_ANIM_FLAG_AESTATUS

◆ PROP_ANIM_FLAG_AETORQUE

◆ PROP_ANIM_FLAG_AILERONS

◆ PROP_ANIM_FLAG_AIRBRAKE

◆ PROP_ANIM_FLAG_AIRSPEED

◆ PROP_ANIM_FLAG_ALTIMETER

◆ PROP_ANIM_FLAG_AOA

◆ PROP_ANIM_FLAG_ARUDDER

◆ PROP_ANIM_FLAG_BRAKE

◆ PROP_ANIM_FLAG_BRUDDER

◆ PROP_ANIM_FLAG_BTHROTTLE

◆ PROP_ANIM_FLAG_CLUTCH

◆ PROP_ANIM_FLAG_DASHBOARD

◆ PROP_ANIM_FLAG_DIFFLOCK

◆ PROP_ANIM_FLAG_ELEVATORS

◆ PROP_ANIM_FLAG_EVENT

◆ PROP_ANIM_FLAG_FLAP

◆ PROP_ANIM_FLAG_HEADING

◆ PROP_ANIM_FLAG_PBRAKE

◆ PROP_ANIM_FLAG_PERMANENT

◆ PROP_ANIM_FLAG_PITCH

◆ PROP_ANIM_FLAG_ROLL

◆ PROP_ANIM_FLAG_RPM

◆ PROP_ANIM_FLAG_SHIFTER

◆ PROP_ANIM_FLAG_SIGNALSTALK

◆ PROP_ANIM_FLAG_SPEEDO

◆ PROP_ANIM_FLAG_STEERING

◆ PROP_ANIM_FLAG_TACHO

◆ PROP_ANIM_FLAG_THROTTLE

◆ PROP_ANIM_FLAG_TORQUE

◆ PROP_ANIM_FLAG_TURBO

◆ PROP_ANIM_FLAG_VVI