HShading Class Reference

Shading time contextual information for a given hit point from a given light. More...

#include <HPropert.h>

Inheritance diagram for HShading:

[legend]Collaboration diagram for HShading:

[legend]List of all members.

Public Member Functions
HTexInfo *	GetTexInfo ()
RGBFloat *	GetACol ()
RGBFloat *	GetDCol ()
RGBFloat *	GetSCol ()
Vector *	GetAway ()
Vector *	GetL ()
float	GetIntensity ()
float	GetLDot ()
float	GetEDot ()
int	GetObjectType ()
HObject *	GetObject ()
void *	GetSubObject ()
Vector	GetHitP ()

---

Detailed Description

Shading time contextual information for a given hit point from a given light.

Definition at line 1031 of file HPropert.h.

---

Member Function Documentation

RGBFloat * HShading::GetACol (   )

Retrieves a pointer to the RGBFloat which contains the surface current ambiance color. From this pointer, the plugin may store a newly computed ambiance color.

Vector * HShading::GetAway (   )

Retrieves a pointer to a normalized vector representing the reflected ray away from light at surface hit point. The Away vector is the mirror direction of the light vector about the surface normal. It is pointing away from the surface.

RGBFloat * HShading::GetDCol (   )

Retrieves a pointer to the RGBFloat which contains the current diffuse color. From this pointer, the plugin may store a newly computed diffuse color.

float HShading::GetEDot (   )

Retrieves the dot product (cosine of the angle) between the eye normalized vector and the surface normal. Note: The cosine is projected on the surface normal.

Vector HShading::GetHitP (   )

Retrieves the hit point, in screen space, on the object surface corresponding to the pixel being shaded.

float HShading::GetIntensity (   )

Retrieves the light intensity

Vector * HShading::GetL (   )

Retrieves a pointer to a normalized vector from incoming light direction at surface hit point. In screen space. Must be negated to get a vector pointing away from surface, toward the light.

float HShading::GetLDot (   )

Retrieves the dot product (cosine of the angle) between the light normalized vector and the surface normal. Note: The cosine is projected on the surface normal.

HObject * HShading::GetObject (   )

Retrieves a pointer to the object being shaded. The pointer must be casted to the appropriate object which can be determined with GetObjectType(). For instance, when the object type is FIGUREOBJ, then the pointer should be cast to (HModel *). Reimplemented from HAnimObject.

int HShading::GetObjectType (   )

Retrieves the Object Type of the object being shaded. The object type can be any value from those enumerated in RType.h. If the object type is FIGUREOBJ, then GetObject() can be used to get to the HModel which is being shaded. Note: This will not return the same object type as HHashObject. Reimplemented from HHashObject.

RGBFloat * HShading::GetSCol (   )

Retrieves a pointer to the RGBFloat which contains the current specular color. From this pointer, the plugin may store a newly computed specular color.

void * HShading::GetSubObject (   )

Retrieves a pointer to the sub object being shaded. Note: When the raytracer hits a model, GetObject() hit retrieve a pointer to an object that derives off of RObject (Renderable Object). If the Object is a FIGUREOBJ, thus a HModel, then the sub object would be the HPatch that it hit. If the Object is a RPROP the sub object would be a IEPoly.

HTexInfo * HShading::GetTexInfo (   )

Retrieves a pointer to the HTexInfo which describes the surface attributes at hit point.

---

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

• C:/Program Files/Hash Inc/AM120SDK/Include/SDK/HPropert.h
• C:/Dox/SDK/Comments/HPropert.dox

---