## Index of OpenRM - RM Library

     RMlight * rmLightNew (void)

     No arguments.

Creates a new RMlight object, returning a handle to the new object to the caller.

The RMlight object is initialized with these values:

1. Light type set to RM_LIGHT_DIRECTIONAL (see rmLightSetType).

2. Light direction set to {0.0, 0.0, 1.0} (see rmLightSetXYZ).

3. Light ambient, diffuse and specular colors set to {0, 0, 0}, {0.75, 0.75, 0.75} and {1.0, 1.0, 1.0} respectively (see rmLightSetColor).

4. Spotlight direction, and cutoff set to {0,0,-1} and 90 degrees, respectively (see rmLightSetSpotDirection and rmLightSetSpotCutoff). Note that these parameters have no meaning with a light source that is not a spotlight.

5. Light attenuation coefficients consist of a constant, linear and quadratic terms. These are initialized to 1.0, 0.0 and 0.0, respectively (see rmLightSetAttenuation).

6. The light is enabled (see rmLightSetEnable) with RM_TRUE.

Notes:

The process of lighting in RM consists of a number of interrelated factors. One is the presence of light sources in the scene as scene parameters assigned to RMnodes. Another is the specification of a light model, another scene parameter that specifies whether or not lighting is two-sided (illumination of both front- and back-facing polygons by ignoring the sign of the dot product of the surface normal with the direction to/of the light source). Third, objects to be illuminated must have 3D surface normals. The absence of any of these three components will cause lighting/shading to "not work."

Note that setting attributes in an RMlight does not change them in the scene graph. They must be assigned as scene parameters to an RMnode before they will be used in rendering (see rmNodeSetSceneLight).

librm library source file: rmlites.c

     void rmLightDelete (RMlight *toDelete)

     RMlight *toDelete - a handle to an RMlight object.

Frees resources associated with an RMlight object. This routine is the opposite of rmLightNew().

librm library source file: rmlites.c

     RMenum rmLightSetType (RMlight *toModify,
    	                RMenum newType)

     RMlight *toModify - a handle to an RMlight object (modified).

     RMenum newType - an RMenum value specifying the new light type for
        the RMlight object. Must be one of RM_LIGHT_POINT,
        RM_LIGHT_DIRECTIONAL, or RM_LIGHT_SPOT (input).

RM light sources may be directional, spot or point light sources, and this routine is used to set the type of an RMlight object to one of those light source types. Returns RM_CHILL upon success, or RM_WHACKED upon failure.

RMlight objects represent light sources. Of the parameters in an RMlight object, some are used regardless of light source type, while others have meaning only for certain types of lights.

The ambient, diffuse and specular color attributes are used by all light source types (see rmLightSetColor). Also, the light attenuation coefficients are used by all light source types (see rmLightSetAttenuation).

All light sources have a 3D coordinate associated with them, set with rmLightSetXYZ. The position of Point light sources (RM_LIGHT_POINT) and spotlight sources (RM_LIGHT_SPOT) is specified with rmLightSetXYZ. Directional light sources have their orientation vector specified with rmLightSetXYZ.

Note that setting attributes in an RMlight does not change them in the scene graph. They must be assigned as scene parameters to an RMnode before they will be used in rendering (see rmNodeSetSceneLight).

librm library source file: rmlites.c

     RMenum rmLightGetType (const RMlight *toQuery)

     const RMlight *toQuery - a handle to an RMlight object (input).

Upon success, returns to the caller the RMlight light source type; RM_LIGHT_POINT, RM_LIGHT_SPOT or RM_LIGHT_DIRECTIONAL. Otherwise, returns RM_WHACKED.

librm library source file: rmlites.c

     RMenum rmLightSetXYZ (RMlight *toModify,
    	               const RMvertex3D *newXYZ)

     RMlight *toModify - a handle to an RMlight object (modified).

     const RMvertex3D *newXYZ - a handle to an RMvertex3D object (input).

This routine is used to set the XYZ attribute of a light source object, controlling the position of RM_LIGHT_POINT and RM_LIGHT_SPOT sources, or the direction of RM_LIGHT_DIRECTIONAL objects. Copies from the caller-supplied RMvertex3D object into the RMlight object.

Returns RM_CHILL upon success, or RM_WHACKED upon failure.

Note that setting attributes in an RMlight does not change them in the scene graph. They must be assigned as scene parameters to an RMnode before they will be used in rendering (see rmNodeSetSceneLight).

librm library source file: rmlites.c

     RMenum rmLightGetXYZ (const RMlight *toQuery,
    	               RMvertex3D *retXYZ)

     const RMlight *toQuery - a handle to an RMlight object (input).

     RMvertex3D *retXYZ - a handle to an RMvertex3D object (modified).

Upon success, copies the light source's XYZ position/orientation attribute from the RMlight object into the caller-supplied memory, and returns RM_CHILL. Upon failure, returns RM_WHACKED.

librm library source file: rmlites.c

     RMenum rmLightSetColor (RMlight *toModify,
    		         const RMcolor4D *newAmbientColor,
    			 const RMcolor4D *newDiffuseColor,
    			 const RMcolor4D *newSpecularColor)

     RMlight *toModify - a handle to an RMlight object (modified).

     const RMcolor4D *newAmbientColor, *newDiffuseColor, *newSpecularColor
        - handles to RMcolor4D objects specifying the RGBA colors for the
        light source ambient, diffuse and specular light terms.  Use of
        NULL for some or all terms is acceptable (input).

In RM (and OpenGL), the final shade computed at a vertex is a function of the vertex color, the current material properties and the light source(s). OpenGL uses a Phong-type shading model at each vertex that computes the dot product of the surface normal at the vertex (specified by the application) with the direction to each light source (directional light sources require less work at this stage than positional light sources). This dot product to weight the diffuse and specular reflectance terms of the shading equation.

The Phong shading equation has terms for three types of light reflectance: ambient, diffuse and specular. It is possible for applications to specify the ambient, diffuse and specular terms (colors) for both the light sources as well as the objects in the scene to implement custom scenes like a yellow light shining on a green ball.

This routine is used to set the ambient, diffuse and specular color terms for a specific light source.

Note that the "global ambient light" level is set in the RMlightModel object, not in the RMlight object (see rmLightModelNew).

It is possible for applications to selectively modify a particular reflectence color term - by specifying NULL for one of the input color vectors, that term in the RMlight object is not modified. In other words, only those non-NULL color terms are modified in the RMlight object.

Upon success, this routine copies from the caller-supplied RMcolor4D objects into the RMlight object and returns RM_CHILL. Otherwise, RM_WHACKED is returned.

Note that setting attributes in an RMlight does not change them in the scene graph. They must be assigned as scene parameters to an RMnode before they will be used in rendering (see rmNodeSetSceneLight).

librm library source file: rmlites.c

     RMenum rmLightGetColor (const RMlight *toQuery,
    		         RMcolor4D *retAmbientColor,
    			 RMcolor4D *retDiffuseColor,
    			 RMcolor4D *retSpecularColor)

     const RMlight *toQuery - a handle to an RMlight object (input).

     RMcolor4D *retAmbientColor, *retDiffuseColor, *retSpecularColor -
        handles to RMcolor4D objects (modified). Use of NULL for some or
        all terms is acceptable (input).

Use this routine to obtain one or more light source color vectors from an RMlight object. Upon success, one or more color vectors is copied from the RMlight object into caller-supplied memory, and RM_CHILL is returned. Otherwise, RM_WHACKED is returned.

librm library source file: rmlites.c

     RMenum rmLightSetAttenuation (RMlight *toModify,
    		               float newConstantAttenuation,
    			       float newLinearAttenuation,
    			       float newQuadraticAttenuation)

     RMlight *toModify - a handle to an RMlight object (modified).

     float newConstantAttenuation, newLinearAttenuation,
        newQuadraticAttenuation - floating point values specifying the
        coefficients for constant, linear and quadratic light attenuation,
        or decay, for an RMlight source (input).

In the real world, light intensity decays as a function of distance from the light source. The further away from the light source, the weaker the light. The rate at which light decays is largely a function of the medium through which the light energy passes. In a vaccuum, like space, light decays slowly. In another medium, like water, light decays more rapidly as the light energy is absorbed by the participating medium.

Applications have some measure of control over how light energy decays as a function of distance from the light source through the manipulation of "light attenuation factors." The equation used to compute attenuation of light intensity at some point in space is:

L = 1 / (Kc + Kl * d + Kq * d^2)

where d is the distance to the light source.

By default, that constant term (Kc) is set to 1.0, and the linear (Kl) and quadratic (Kq) terms are set to zero; light energy does not decay at all. Most OpenGL implementations are optimized for this condition.

Upon success, the three attenuation coefficients are copied into the RMlight object, and RM_CHILL is returned. Otherwise, RM_WHACKED is returned.

Note that setting attributes in an RMlight does not change them in the scene graph. They must be assigned as scene parameters to an RMnode before they will be used in rendering (see rmNodeSetSceneLight).

librm library source file: rmlites.c

     RMenum rmLightGetAttenuation (const RMlight *toQuery,
    		               float *retConstantAttenuation,
    			       float *retLinearAttenuation,
    			       float *retQuadraticAttenuation)

     const RMlight *toQuery - a handle to an RMlight object (input).

     float *retConstantAttenuation, *retLinearAttenuation,
        *retQuadraticAttenuation - handle to caller-supplied floats
        (modified).

Upon success, copies the three light attenuation factors into caller-supplied memory and returns RM_CHILL. Otherwise, RM_WHACKED is returned.

Note that all three input parameters must be non-NULL, otherwise an error condition is produced.

See rmLightSetAttenuation for more details about these attributes.

librm library source file: rmlites.c

     RMenum rmLightSetEnable (RMlight *toModify,
    		          RMenum newValue)

     RMlight *toModify - a handle to an RMlight object (modified).

     RMenum newValue - an RMenum value, must be either RM_TRUE or
        RM_FALSE.

Light sources may be individually turned on or off by using this routine. To turn a light on, use RM_TRUE, and to turn it off, use RM_FALSE.

Upon success, the newValue attribute is copied into the RMlight object, and RM_CHILL is returned, otherwise RM_WHACKED is returned.

Note that setting attributes in an RMlight does not change them in the scene graph. They must be assigned as scene parameters to an RMnode before they will be used in rendering (see rmNodeSetSceneLight).

librm library source file: rmlites.c

     RMenum rmLightGetEnable (const RMlight *toQuery)

     const RMlight *toQuery - a handle to an RMlight object (input).

Upon success, returns to the caller either RM_TRUE or RM_FALSE, indicating that the light source is either turned on or turned off, respectively. Otherwise, returns RM_WHACKED.

librm library source file: rmlites.c

     RMenum rmLightSetSpotDirection (RMlight *toModify,
    			         const RMvertex3D *newSpotDirection)

     RMlight *toModify - a handle to an RMlight object (modified).

     const RMvertex3D *newSpotDirection - a handle to an RMvertex3D object
        (input).

Spotlight geometry is specified with both a position (rmLightSetXYZ) and a direction (rmLightSetSpotDirection). This routine is used to set the 3D orientation, or direction, of the spotlight light source.

Upon success, this routine will copy the 3D vector from the caller-supplied RMvertex3D object into the RMlight object and return RM_CHILL. Upon failure, RM_WHACKED is returned.

Note that setting attributes in an RMlight does not change them in the scene graph. They must be assigned as scene parameters to an RMnode before they will be used in rendering (see rmNodeSetSceneLight).

librm library source file: rmlites.c

     RMenum rmLightGetSpotDirection (const RMlight *toModify,
    			         RMvertex3D *retDirection)

     const RMlight *toModify - a handle to an RMlight object (input).

     RMvertex3D *retDirection - a handle to an RMvertex3D object
        (modified, return).

Spotlights are specified with both a position (rmLightSetXYZ) and a direction (rmLightSetSpotDirection). Use this routine to obtain the direction vector of a spotlight source.

Upon success, this routine copies the spotlight direction vector from the RMlight object into the caller-supplied memory and returns RM_CHILL. Upon failure, RM_WHACKED is returned.

librm library source file: rmlites.c

     RMenum rmLightSetSpotCutoff (RMlight *toModify,
    		              float newValue)

     RMlight *toModify - a handle to an RMlight object (modified).

     float newValue - a floating point value in the range [0..90] (or the
        special value of 180) specifying the spread angle of the
        spotlight (input).

The spotlight light source consists of a number of parameters. Spotlight position is it's location in 3-space (rmLightSetXYZ). The direction in which the spotlight is pointed is it's orientation (rmLightSetSpotDirection). The light color consists of ambient, diffuse and specular colors (rmLightSetColor). The rate at which light decays as a function of distance from the light source position is specified with constant, linear and quadratic coefficients (rmLightSetAttenuation). The spread angle of the spotlight is a measure of the half-angle, in degrees, of the apex of a cone formed by the spotlight, with the light positioned at the apex of the cone and oriented towards the base of the cone (rmLightSetSpotCutoff). Finally, the rate at which light decays, or falls off, as a function of distance from the vector formed by the center of the spotlight cone (rmLightSetSpotExponent).

This routine is used to set the value that controls the spread angle of the spotlight light source. The value must be in the range 0 to 90, or the special value 180. This value specifies the half-angle of the cone apex formed by the illumination volume of the spotlight source. The spotlight source is positioned at the apex of this cone, and shines in the direction of the base of the cone. The greater this value, the larger the illumination volume. A value of 45 (degrees) specifies an illumination volume with a cone apex of 90 degrees.

The special value of 180.0 specifies a spotlight source that shines in all directions.

Upon success, the spotlight cutoff attribute of the RMlight object is modified, and RM_CHILL is returned to the caller. Otherwise, RM_WHACKED is returned.

Note that setting attributes in an RMlight does not change them in the scene graph. They must be assigned as scene parameters to an RMnode before they will be used in rendering (see rmNodeSetSceneLight).

librm library source file: rmlites.c

     RMenum rmLightGetSpotCutoff (const RMlight *toQuery,
    		              float *retValue)

     const RMlight *toQuery - a handle to an RMlight object (input).

     float *retValue - a handle to a caller-supplied float (modified).

Use this routine to obtain the spotlight cutoff value from an RMlight object. Upon success, the spotlight cutoff value is copied into the caller-supplied memory and RM_CHILL is returned. Otherwise, RM_WHACKED is returned.

See rmLightSetSpotCutoff for more details about the meaning of the spotlight cutoff attribute.

librm library source file: rmlites.c

     RMenum rmLightSetSpotExponent (RMlight *toModify,
    		                float newValue)

     RMlight *toModify - a handle to an RMlight object (modified).

     float newValue - a non-negative floating point value (input).

The spotlight light source consists of a number of parameters. Spotlight position is it's location in 3-space (rmLightSetXYZ). The direction in which the spotlight is pointed is it's orientation (rmLightSetSpotDirection). The light color consists of ambient, diffuse and specular colors (rmLightSetColor). The rate at which light decays as a function of distance from the light source position is specified with constant, linear and quadratic coefficients (rmLightSetAttenuation). The spread angle of the spotlight is a measure of the half-angle, in degrees, of the apex of a cone formed by the spotlight, with the light positioned at the apex of the cone and oriented towards the base of the cone (rmLightSetSpotCutoff). Finally, the rate at which light decays, or falls off, as a function of distance from the vector formed by the center of the spotlight cone (rmLightSetSpotExponent).

This routine is used to set the spotlight exponent value, or the rate at which light decays as a function of distance from the center of the illumination cone. By default, this parameter is set to zero, indicating uniform light distribution (no decay) within the illumination cone. Since this attribute specifies an exponent, light decay falls off more rapidly as the value for this parameter increases. Linear decay (inverse distance) is specified using a value of 1.0 for this parameter; a value of 2.0 specifies that light falls off as the inverse of the square of the distance to the center of the illumination cone.

Upon success, this routine copies the caller-supplied newValue floating point value into the RMlight object's spotlight exponent attribute and returns RM_CHILL, otherwise RM_WHACKED is returned.

Note that setting attributes in an RMlight does not change them in the scene graph. They must be assigned as scene parameters to an RMnode before they will be used in rendering (see rmNodeSetSceneLight).

librm library source file: rmlites.c

     RMenum rmLightGetSpotExponent (const RMlight *toQuery,
    		                float *retValue)

     const RMlight *toQuery - a handle to an RMlight object (input).

     float *retValue - a handle to a caller-supplied float (modified).

Use this routine to obtain the spotlight exponent attribute of an RMlight object. Upon success, the spotlight exponent attribute of the RMlight object is copied into caller-supplied memory, and RM_CHILL is returned. Otherwise, RM_WHACKED is returned.

See rmLightSetSpotExponent for more details about the meaning and use of this attribute.

librm library source file: rmlites.c

     RMlightModel * rmLightModelNew (void)

     No arguments.

Creates a new RMlightModel object, initializes it with default values, and returns to handle to the caller. NULL is returned upon failure.

Lighting in RM (and OpenGL) is a function of light sources and the lighting environment. The RMlight objects contain information about the specific light sources, such as their position, light decay properties, color and so forth. The RMlightModel object controls global lighting parameters, including global ambient illumination, two-sided illumination control and selection of one of two algorithms used to compute specular reflection values.

Global ambient illumination is the amount of light that is present everywhere in the scene, and represents the combination of overall composite luminance with the degree to which light is scattered. By default, the ambient color assigned to the RMlightModel object is {0.,0.,0.}, indicating the absence of global ambient light. During shading, the global ambient term is applied to all vertices, regardless of the amount of ambient light specified in an RMlight object. This term can be thought of as another independent light source in the scene (see rmLightModelSetAmbient).

Two-sided illumination is used to create the effect of a bi-directional light source. By default, two-sided lighting is turned off (see rmLightModelSetTwoSided).

Specular reflections take into account the surface normal, the direction to the light source from a vertex, and the direction to the viewer from the vertex. When the "local viewer" attribute is set to RM_TRUE, the direction to the viewer from each vertex is calculated during shading. This results in more realistic shading, but at added computational expense. When set to RM_FALSE, the position of the viewer is fixed at (0,0,0) in eye coordinates (not world coordinates) for the purposes of shading.

Note: OpenGL 1.2 adds a new term to the lighting model that can be used to control the computation specular reflection color. This feature has not yet been integrated into RM.

Applications need to create both a light source and a light model in order for lighting to work properly.

librm library source file: rmlites.c

     RMenum rmLightModelDelete (RMlightModel *toDelete)

     RMlightModel *toDelete - a handle to an RMlightModel object to be
        deleted (modified).

Releases resources associated with an RMlightModel object. Returns RM_CHILL upon success, or RM_WHACKED upon failure. This routine is the opposite of rmLightModelNew.

librm library source file: rmlites.c

     RMenum rmLightModelSetAmbient (RMlightModel *toModify,
    			        const RMcolor4D *newAmbientColor)

     RMlightModel *toModify - a handle to an RMlightModel object (modified).

     const RMcolor4D *newAmbientColor - a handle to an RMcolor4D object
        (input).

Upon success, copies the contents of the RMcolor4D object to the RMlightModel object, and returns RM_CHILL. Otherwise, RM_WHACKED is returned.

Color attributes are specified with floating point values in the range 0..1, where 0 is "off" and 1 is "on." The RMcolor4D object represents red, green, blue and alpha.

See rmLightModelNew for more information about the global ambient light model attribute.

Note that setting attributes in an RMlightModel does not change them in the scene graph. They must be assigned as scene parameters to an RMnode before they will be used in rendering (see rmNodeSetSceneLightModel).

librm library source file: rmlites.c

     RMenum rmLightModelGetAmbient (const RMlightModel *toQuery,
    			        RMcolor4D *retAmbientColor)

     const RMlightModel *toQuery - a handle to an RMlightModel object
        (input).

     RMcolor4D *retAmbientColor - a handle to an RMcolor4D object
        (modified).

Upon success, this routine will copy the global ambient light attribute from the RMlightModel object into the caller-supplied RMcolor4D object, and return RM_CHILL. Otherwise, RM_WHACKED is returned.

See rmLightModelNew for more information about the global ambient light model attribute.

librm library source file: rmlites.c

     RMenum rmLightModelSetTwoSided (RMlightModel *toModify,
    			         RMenum newValue)

     RMlightModel *toModify - a handle to an RMlightModel object
        (modified).

     RMenum newValue - an RMenum value, should be either RM_TRUE or
        RM_FALSE (input).

This routine sets the two-sided lighting attribute of an RMlightModel object. When RM_TRUE is specified, two-sided lighting is activitated for this light model. When set to RM_FALSE, two-sided lighting is disabled, and single-sided lighting takes effect.

Returns RM_CHILL upon success, or RM_WHACKED upon failure.

Note that setting attributes in an RMlightModel does not change them in the scene graph. They must be assigned as scene parameters to an RMnode before they will be used in rendering (see rmNodeSetSceneLightModel).

librm library source file: rmlites.c

     RMenum rmLightModelGetTwoSided (const RMlightModel *toQuery)

     const RMlightModel *toQuery - a handle to an RMlightModel object
        (input).

Upon success, returns the setting of the two-sided lighting attribute of an RMlightModel object, either RM_TRUE or RM_FALSE. Otherwise, RM_WHACKED is returned.

librm library source file: rmlites.c

     RMenum rmLightModelSetLocalViewer (RMlightModel *toModify,
    			            RMenum newValue)

     RMlightModel *toModify - a handle to an RMlightModel object
        (modified).

     RMenum newValue - an RMenum value, must be either RM_TRUE or RM_FALSE
        (input).

This routine will set the "local viewer" attribute of the RMlightModel object to the value specified by the caller and return RM_CHILL upon success. Otherwise, RM_WHACKED is returned.

See rmLightModelNew for more information about the "local viewer" attribute.

Note that setting attributes in an RMlightModel does not change them in the scene graph. They must be assigned as scene parameters to an RMnode before they will be used in rendering (see rmNodeSetSceneLightModel).

librm library source file: rmlites.c

     RMenum rmLightModelGetLocalViewer (const RMlightModel *toQuery)

     const RMlightModel *toQuery - a handle to an RMlightModel object
        (input).

Upon success, returns the "local viewer" attribute of the RMlightModel object. Otherwise, RM_WHACKED is returned.

See rmLightModelNew for more information about the "local viewer" attribute of the RMlightModel object.

librm library source file: rmlites.c

     RMenum rmDefaultLighting (RMnode *toModify)

     RMnode *toModify - a handle to an RMnode (modified).

This convenience routine is used to create a default set of lights and a default lighting model, and to assign them as scene parameters to an RMnode. The new lights and lighting model have effect over all children of the specified RMnode.

The default lighting configuration consists of:

1. One directional light source at 0,10,3 (overhead and slightly behind the viewer) with no ambient term, diffuse set to (0.7,0.7,0.7,1.0) and specular set to (0.5,0.5,0.5,1.0). A second light source is available by uncommenting one line of code inside this routine.

2. A light model with global ambient light set to (0.2,0.2,0.2,1.0), two-sided lighting disabled and disabling of "local viewer" specular reflection calculations.

The net result is a lighting model that works reasonably well for most scenes both in terms of performance as well as illumination characteristics. While this convenience function is useful, developers are encouraged to examine this routine because it is a good example of how to create and modify light sources and light models, as well as assign them as scene parameters to an RMnode.

Returns RM_CHILL upon success, or RM_WHACKED upon failure.

librm library source file: rmlites.c