KiCad PCB EDA Suite
MATERIAL_GENERATOR Class Referenceabstract

A base class that can be used to derive procedurally generated materials. More...

#include <material.h>

Inheritance diagram for MATERIAL_GENERATOR:
BOARD_NORMAL BRUSHED_METAL_NORMAL COPPER_NORMAL PLASTIC_NORMAL PLASTIC_SHINE_NORMAL PLATED_COPPER_NORMAL SILK_SCREEN_NORMAL SOLDER_MASK_NORMAL

Public Member Functions

 MATERIAL_GENERATOR ()
 
virtual ~MATERIAL_GENERATOR ()
 
virtual SFVEC3F Generate (const RAY &aRay, const HITINFO &aHitInfo) const =0
 Generate a 3D vector based on the ray and hit information depending on the implementation. More...
 

Detailed Description

A base class that can be used to derive procedurally generated materials.

Definition at line 39 of file material.h.

Constructor & Destructor Documentation

◆ MATERIAL_GENERATOR()

MATERIAL_GENERATOR::MATERIAL_GENERATOR ( )

Definition at line 135 of file material.cpp.

136 {
137 }

◆ ~MATERIAL_GENERATOR()

virtual MATERIAL_GENERATOR::~MATERIAL_GENERATOR ( )
inlinevirtual

Definition at line 44 of file material.h.

45  {
46  }

Member Function Documentation

◆ Generate()

virtual SFVEC3F MATERIAL_GENERATOR::Generate ( const RAY aRay,
const HITINFO aHitInfo 
) const
pure virtual

Generate a 3D vector based on the ray and hit information depending on the implementation.

Parameters
aRaythe camera ray that hits the object
aHitInfothe hit information
Returns
the result of the procedural

Implemented in SILK_SCREEN_NORMAL, BRUSHED_METAL_NORMAL, PLASTIC_SHINE_NORMAL, PLASTIC_NORMAL, SOLDER_MASK_NORMAL, PLATED_COPPER_NORMAL, COPPER_NORMAL, and BOARD_NORMAL.

Referenced by COPPER_NORMAL::Generate(), SOLDER_MASK_NORMAL::Generate(), and MATERIAL::Generate().


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