Surface material of shape instances in the raytrace environment. More...

#include <RaytraceSurfaceMaterial.h>

Inheritance diagram for agxSensor::RtSurfaceMaterial:

Public Member Functions
RtSurfaceMaterial	assignTo (agx::RigidBody *rb) const
	Assign/associate a surface material to the given rigid body.

RtSurfaceMaterial	assignTo (agxCollide::Geometry *geometry) const
	Assign/associate a surface material to the given geometry.

RtSurfaceMaterial	assignTo (agxCollide::Shape *shape) const
	Assign/associate a surface material to the given shape.

RtSurfaceMaterial	assignTo (agxSDK::LinkedStructure *linkedStructure) const
	Assign/associate a surface material to the given linked structure (agxCable::Cable, agxModel::Beam, agxVehicle::Track, ...).

RtSurfaceMaterial	assignTo (agxTerrain::Terrain *terrain) const
	Assign/associate a surface material to the given terrain.

RtSurfaceMaterial	assignTo (agxTerrain::TerrainPager *terrainPager) const
	Assign/associate a surface material to the given terrain (pager).

RtSurfaceMaterial	assignTo (agxWire::Wire *wire) const
	Assign/associate a surface material to the given wire.

template<typename T >
RtSurfaceMaterial	assignTo (T *instance) const

Public Member Functions inherited from agxSensor::RtMaterial
	RtMaterial ()
	Construct an invalid material.

	RtMaterial (RtMaterialInstance instance)
	Construct given instance.

RtMaterialHandleRef	getHandle () const

RtMaterialHandle::Type	getType () const

bool	isValid () const

	operator RtMaterialInstance () const

bool	operator!= (const RtMaterial &other) const

bool	operator== (const RtMaterial &other) const

Static Public Member Functions
template<typename T , typename InstanceT >
static T	getAs (const InstanceT *instance)

static void	set (agx::RigidBody *rb, RtSurfaceMaterial surfaceMaterial)
	Assign/associate a surface material to the given rigid body.

static void	set (agxCollide::Geometry *geometry, RtSurfaceMaterial surfaceMaterial)
	Assign/associate a surface material to the given geometry.

static void	set (agxCollide::Shape *shape, RtSurfaceMaterial surfaceMaterial)
	Assign/associate a surface material to the given shape.

static void	set (agxSDK::LinkedStructure *linkedStructure, RtSurfaceMaterial surfaceMaterial)
	Assign/associate a surface material to the given linked structure (agxCable::Cable, agxModel::Beam, agxVehicle::Track, ...).

static void	set (agxTerrain::Terrain *terrain, RtSurfaceMaterial surfaceMaterial)
	Assign/associate a surface material to the given terrain.

static void	set (agxTerrain::TerrainPager *terrainPager, RtSurfaceMaterial surfaceMaterial)
	Assign/associate a surface material to the given terrain (pager).

static void	set (agxWire::Wire *wire, RtSurfaceMaterial surfaceMaterial)
	Assign/associate a surface material to the given wire.

Protected Member Functions
	RtMaterial ()
	Construct an invalid material.

	RtMaterial (RtMaterialInstance instance)
	Construct given instance.

Detailed Description

Surface material of shape instances in the raytrace environment.

Definition at line 32 of file RaytraceSurfaceMaterial.h.

Member Function Documentation

◆ assignTo() [1/8]

RtSurfaceMaterial agxSensor::RtSurfaceMaterial::assignTo ( agx::RigidBody * rb ) const

Assign/associate a surface material to the given rigid body.

All geometries (and their shapes) of the given rigid body will inherit surfaceMaterial unless they haven't been explicitly assigned/associated a material.

Parameters

rb	- rigid body to use the given `surfaceMaterial`

◆ assignTo() [2/8]

RtSurfaceMaterial agxSensor::RtSurfaceMaterial::assignTo ( agxCollide::Geometry * geometry ) const

Assign/associate a surface material to the given geometry.

All shapes of the given geometry will inherit surfaceMaterial unless they haven't been explicitly assigned/associated a material.

Parameters

geometry - geometry to use the given surfaceMaterial

◆ assignTo() [3/8]

RtSurfaceMaterial agxSensor::RtSurfaceMaterial::assignTo ( agxCollide::Shape * shape ) const

Assign/associate a surface material to the given shape.

If/when the shape is added to a raytrace environment, surfaceMaterial will be used.

Parameters

shape - shape to use the given surfaceMaterial

◆ assignTo() [4/8]

RtSurfaceMaterial agxSensor::RtSurfaceMaterial::assignTo ( agxSDK::LinkedStructure * linkedStructure ) const

Assign/associate a surface material to the given linked structure (agxCable::Cable, agxModel::Beam, agxVehicle::Track, ...).

Parameters

linkedStructure - linked structure to use the given surfaceMaterial

◆ assignTo() [5/8]

RtSurfaceMaterial agxSensor::RtSurfaceMaterial::assignTo ( agxTerrain::Terrain * terrain ) const

Assign/associate a surface material to the given terrain.

The particles/granulars created from this terrain will also inherit the given material.

Parameters

terrain - terrain to use the given surfaceMaterial

◆ assignTo() [6/8]

RtSurfaceMaterial agxSensor::RtSurfaceMaterial::assignTo ( agxTerrain::TerrainPager * terrainPager ) const

Assign/associate a surface material to the given terrain (pager).

The particles/granulars created from terrain of this pager will also inherit the given material.

Parameters

terrainPager - terrain pager to use the given surfaceMaterial

◆ assignTo() [7/8]

RtSurfaceMaterial agxSensor::RtSurfaceMaterial::assignTo ( agxWire::Wire * wire ) const

Assign/associate a surface material to the given wire.

Parameters

wire	- wire to use the given `surfaceMaterial`

◆ assignTo() [8/8]

template<typename T >

RtSurfaceMaterial agxSensor::RtSurfaceMaterial::assignTo ( T * instance ) const

inline

Definition at line 150 of file RaytraceSurfaceMaterial.h.

◆ getAs()

template<typename T , typename InstanceT >

T agxSensor::RtSurfaceMaterial::getAs ( const InstanceT * instance )

static

Returns: the surface material associated with the given shape

Definition at line 161 of file RaytraceSurfaceMaterial.h.

◆ RtMaterial() [1/2]

agxSensor::RtMaterial::RtMaterial ( )

inlineprotected

Construct an invalid material.

Definition at line 30 of file RaytraceMaterial.h.

◆ RtMaterial() [2/2]

agxSensor::RtMaterial::RtMaterial ( RtMaterialInstance instance )

inlineprotected

Construct given instance.

Definition at line 35 of file RaytraceMaterial.h.

◆ set() [1/7]

static void agxSensor::RtSurfaceMaterial::set	(	agx::RigidBody *	rb,
		RtSurfaceMaterial	surfaceMaterial
	)

static

Assign/associate a surface material to the given rigid body.

All geometries (and their shapes) of the given rigid body will inherit surfaceMaterial unless they haven't been explicitly assigned/associated a material.

Parameters

rb	- rigid body to use the given `surfaceMaterial`
surfaceMaterial	- surface material instance

◆ set() [2/7]

static void agxSensor::RtSurfaceMaterial::set	(	agxCollide::Geometry *	geometry,
		RtSurfaceMaterial	surfaceMaterial
	)

static

Assign/associate a surface material to the given geometry.

All shapes of the given geometry will inherit surfaceMaterial unless they haven't been explicitly assigned/associated a material.

Parameters

geometry	- geometry to use the given `surfaceMaterial`
surfaceMaterial	- surface material instance

◆ set() [3/7]

static void agxSensor::RtSurfaceMaterial::set	(	agxCollide::Shape *	shape,
		RtSurfaceMaterial	surfaceMaterial
	)

static

Assign/associate a surface material to the given shape.

If/when the shape is added to a raytrace environment, surfaceMaterial will be used.

Parameters

shape	- shape to use the given `surfaceMaterial`
surfaceMaterial	- surface material instance

◆ set() [4/7]

static void agxSensor::RtSurfaceMaterial::set	(	agxSDK::LinkedStructure *	linkedStructure,
		RtSurfaceMaterial	surfaceMaterial
	)

static

Assign/associate a surface material to the given linked structure (agxCable::Cable, agxModel::Beam, agxVehicle::Track, ...).

Parameters

linkedStructure	- linked structure to use the given `surfaceMaterial`
surfaceMaterial	- surface material instance

◆ set() [5/7]

static void agxSensor::RtSurfaceMaterial::set	(	agxTerrain::Terrain *	terrain,
		RtSurfaceMaterial	surfaceMaterial
	)

static

Assign/associate a surface material to the given terrain.

The particles/granulars created from this terrain will also inherit the given material.

Parameters

terrain	- terrain to use the given `surfaceMaterial`
surfaceMaterial	- surface material instance

◆ set() [6/7]

static void agxSensor::RtSurfaceMaterial::set	(	agxTerrain::TerrainPager *	terrainPager,
		RtSurfaceMaterial	surfaceMaterial
	)

static

Assign/associate a surface material to the given terrain (pager).

The particles/granulars created from terrain of this pager will also inherit the given material.

Parameters

terrainPager	- terrain pager to use the given `surfaceMaterial`
surfaceMaterial	- surface material instance

◆ set() [7/7]

static void agxSensor::RtSurfaceMaterial::set	(	agxWire::Wire *	wire,
		RtSurfaceMaterial	surfaceMaterial
	)

static

Assign/associate a surface material to the given wire.

Parameters

wire	- wire to use the given `surfaceMaterial`
surfaceMaterial	- surface material instance

The documentation for this class was generated from the following file:

RaytraceSurfaceMaterial.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ assignTo() [1/8]

◆ assignTo() [2/8]

◆ assignTo() [3/8]

◆ assignTo() [4/8]

◆ assignTo() [5/8]

◆ assignTo() [6/8]

◆ assignTo() [7/8]

◆ assignTo() [8/8]

◆ getAs()

◆ RtMaterial() [1/2]

◆ RtMaterial() [2/2]

◆ set() [1/7]

◆ set() [2/7]

◆ set() [3/7]

◆ set() [4/7]

◆ set() [5/7]

◆ set() [6/7]

◆ set() [7/7]