Manages the different ground materials in the scene associating each one with an Unity PhysicMaterial.
A GameObject with a VPGroundMaterialManager component should be available at the scene for the vehicles to use the properties of the ground materials.
When a wheel of a vehicle touches any non-trigger collider it queries the VPGroundMaterialManager
instance passing the PhysicMaterial of the touched collider (it may be null if the collider has no
physic material assigned). The Ground Material Manager looks up the physic material in its
Ground Materials list and returns the first
GroundMaterial object that matches the given
physic material. If no match is found then the Fallback material is returned.
Note that None is also valid as physic material for identifying a ground material. This would match the colliders without physic material assigned.
Loading scenes and objects from bundles
Unity bundles store copies of the physic materials. When the bundle loaded, the physic materials are loaded as new instances, not references to the original. Thus, a GroundMaterialManager existing in the scene wouldn't recognize those materials.
- Include the VPGroundMaterialManager object in the bundle, so references to the physic materials are preserved.
- Explicitly fix the references to the physic materials in the colliders after loading the bundle. You can compare by name and assign a correct reference so the physic materials can be found in the GroundMaterialManager list.
VehiclePhysics.GroundMaterial holds the data and objects associates to a specific ground
material. The Ground Materials are defined and managed at the VPGroundMaterialManager component.
Ground Materials are used by the vehicle and its add-ons.
- Physic Material
- The Unity physic material associated to this ground material. Used for finding the Ground Material when wheel hits a collider with that physic material assigned. None is also valid for identifying colliders without physic material assigned.
Grip multiplier of the surface. Some reference examples are:
Surface Grip Dry tarmac 1 Wet tarmac 0.82 Snow 0.3 Ice 0.1
Drag force based on the speed and load of the wheel on the surface. The formula for computing the force magnitude is:
$$ F_d = \rho \times F_z \times v^2 $$
$F_d$is the drag force in Newtons $\rho$is the drag coefficient $F_z$is the downforce in Kilonewtons (KN, newtons * 0.001) $v$is the velocity of the wheel over the surface in m/s
- Marks Renderer
- Optional reference to a VPGroundMarksRenderer component for drawing the tire marks on this ground material. Marks will be triggered by the component VPTireEffects if available in the vehicle.
- Particle Emitter
- Optional reference to a VPGroundParticleEmitter component for emitting particles on this ground material. Particles will be triggered by the component VPTireEffects if available in the vehicle.
- Surface Type
A hint on the type of surface. It's mostly used by the vehicle add-on components such as VPAudio for playing different effects.
- Hard surfaces: asphalt, tarmac, concrete, metal...
- Soft surfaces: offroad, mud, grass, sand, gravel...
Dynamically creates and renders the marks over the ground.
Each type of marks is generated by a VPGroundMarksRenderer component bound to a specific GroundMaterial. The component VPGroundMaterialManager manages all the Ground Materials and Ground Mark Renderers for the scene.
Conditions that trigger the tire marks:
Pressure And Skid: marks are generated when tire is skidding over the surface. The intensity of the marks depend on the vertical force (pressure) and the slip velocity. Example: typical skid marks on tarmac.
Pressure Only: marks are generated always when the tire is touching the surface. The intensity of the marks depend on the vertical force (pressure) only. Example: tire marks on mud.
- Pressure Boost
- Intensification of the marks with pressure.
- Max Marks
Maximum number of mark segments the renderer will handle. Old marks will be faded out progressively according to the Fade Out Range parameter.
The number of marks has direct influence on the performance. The entire mesh with the marks needs to be processed each time new segments are added.
- Min Distance
- Minimum distance among two consecutive tire marks.
- Ground Offset
- Distance over the surface the marks are generated at. Increase if Z-fighting problems are observed among the marks and the surface.
- Texture Offset Y
- Offset in the vertical direction the marks texture is clamped at. This improves the visual continuity of marks when the texture don't fully wraps around on the V coordinate.
- Fade Out Range
- Proportion of the old marks that will be progressively faded out when new marks are generated.
- The Mesh Renderer for the marks will use this Material when creating it in runtime. It won't be used if a Mesh Renderer is provided in edit time.
Controls an Unity Particle System for creating the particle effects over the ground. Requires a Particle System component and a material for the particles.
Each type of particle effect is generated by a pair VPGroundParticleEmitter - ParticleSystem. The VPGroundParticleEmitter component is bound to a specific GroundMaterial. The component VPGroundMaterialManager manages all the Ground Materials and Ground Particle Emitters for the scene.
Conditions that trigger the particle effect:
- Pressure And Skid: the tire skidding over the surface triggers the particle effect. The intensity of the effect depends on the vertical force (pressure) and the slip velocity. Example: tire smoke on burnouts.
- Pressure And Velocity: the wheel moving on the surface triggers the particle effect. The intensity of the effect depends on the vertical force (pressure) and the speed. Example: dust clouds on sand.
- Emission Rate
- Rate at which the particles are emitted.
- Emission Shuffle
- Randomness ratio on the emission rate.
- Max Lifetime
- Maximum lifetime of each particle.
- Min Velocity, Max Velocity
- Velocity range for applying intensity to the effect in the Pressure And Velocity mode.
- Wheel Velocity Ratio
- How much of the velocity of movement of the wheel is applied to the particle.
- Tire Velocity Ratio
- How much of the tire velocity over the ground (slip) is applied to the particle.
- Color 1
- Tint color for the particles.
- RandomColor, Color 2
- If RandomColor is checked, a random color in the range Color1 - Color2 will be applied to each new particle.