SPH
Public Member Functions | List of all members
MaterialView Class Reference

Non-owning wrapper of a material and particles with this material. More...

#include <IMaterial.h>

Public Member Functions

INLINE MaterialView (RawPtr< IMaterial > &&material, IndexSequence seq)
 
INLINE IMaterialmaterial ()
 Returns the reference to the material of the particles. More...
 
INLINE IMaterialmaterial () const
 Returns the const reference to the material of the particles. More...
 
INLINE operator IMaterial & ()
 Implicit conversion to the material. More...
 
INLINE operator const IMaterial & () const
 Implicit conversion to the material. More...
 
INLINE RawPtr< IMaterialoperator-> ()
 Overloaded -> operator for convenient access to material functions. More...
 
INLINE RawPtr< const IMaterialoperator-> () const
 Overloaded -> operator for convenient access to material functions. More...
 
INLINE IndexSequence sequence ()
 Returns iterable index sequence. More...
 
INLINE const IndexSequence sequence () const
 Returns iterable index sequence, const version. More...
 

Detailed Description

Non-owning wrapper of a material and particles with this material.

This object serves as a junction between particle storage and a material. It can be used to access material parameters and member function, but also provides means to iterate over particle indices in the storage.

Material accessed through MaterialView shares the constness of the view, i.e. material parameters cannot be modified through const MaterialView.

Definition at line 30 of file IMaterial.h.

Constructor & Destructor Documentation

◆ MaterialView()

INLINE MaterialView::MaterialView ( RawPtr< IMaterial > &&  material,
IndexSequence  seq 
)
inline

Definition at line 36 of file IMaterial.h.

Member Function Documentation

◆ material() [1/2]

INLINE IMaterial& MaterialView::material ( )
inline

Returns the reference to the material of the particles.

Definition at line 43 of file IMaterial.h.

◆ material() [2/2]

INLINE IMaterial& MaterialView::material ( ) const
inline

Returns the const reference to the material of the particles.

Definition at line 49 of file IMaterial.h.

◆ operator const IMaterial &()

INLINE MaterialView::operator const IMaterial & ( ) const
inline

Implicit conversion to the material.

Definition at line 60 of file IMaterial.h.

◆ operator IMaterial &()

INLINE MaterialView::operator IMaterial & ( )
inline

Implicit conversion to the material.

Definition at line 55 of file IMaterial.h.

◆ operator->() [1/2]

INLINE RawPtr<IMaterial> MaterialView::operator-> ( )
inline

Overloaded -> operator for convenient access to material functions.

Definition at line 65 of file IMaterial.h.

◆ operator->() [2/2]

INLINE RawPtr<const IMaterial> MaterialView::operator-> ( ) const
inline

Overloaded -> operator for convenient access to material functions.

Definition at line 70 of file IMaterial.h.

◆ sequence() [1/2]

INLINE IndexSequence MaterialView::sequence ( )
inline

Returns iterable index sequence.

Definition at line 75 of file IMaterial.h.

◆ sequence() [2/2]

INLINE const IndexSequence MaterialView::sequence ( ) const
inline

Returns iterable index sequence, const version.

Definition at line 80 of file IMaterial.h.


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