Main Page   Modules   Alphabetical List   Data Structures   Data Fields  

RpToonInk
[RpToon]


Functions
RpToonInk *  RpToonInkCreate (void)
void  RpToonInkDestroy (RpToonInk *ink)
void  RpToonInkAddRef (RpToonInk *ink)
RpToonInk *  RpToonInkStreamRead (RwStream *stream)
const RpToonInk *  RpToonInkStreamWrite (const RpToonInk *ink, RwStream *stream)
RwReal  RpToonInkGetOverallThickness (const RpToonInk *ink)
void  RpToonInkSetOverallThickness (RpToonInk *ink, RwReal thickness)
RwRGBA  RpToonInkGetColor (const RpToonInk *ink)
void  RpToonInkSetColor (RpToonInk *ink, RwRGBA color)
const RwChar *  RpToonInkGetName (const RpToonInk *ink)
void  RpToonInkSetName (RpToonInk *ink, const RwChar *name)
RwReal  RpToonInkGetPerspectiveScale (const RpToonInk *ink)
void  RpToonInkSetPerspectiveScale (RpToonInk *ink, RwReal perspectiveScale)
RwReal  RpToonInkGetFarScale (const RpToonInk *ink)
void  RpToonInkSetFarScale (RpToonInk *ink, RwReal farScale)

Function Documentation

void RpToonInkAddRef (  RpToonInk *    ink ) 
 

RpToonInkAddRef is used to increment the reference count of an RpToonInk.

Parameters:
ink  the RpToonInk to reference.
Returns:
none.
See also:
RpToonInkDestroy , RpToonInkCreate
RpToonInk* RpToonInkCreate (  void    ) 
 

RpToonInkCreate is used to create a new RpToonInk with default values and a reference count of 1.

Returns:
Returns a pointer to the newly created RpToonInk if successful or NULL if there is an error
See also:
RpToonInkAddRef , RpToonInkDestroy
void RpToonInkDestroy (  RpToonInk *    ink ) 
 

RpToonInkDestroy is used to destroy an RpToonInk. It decrements the ink's reference count, and if it's 0, it is destroyed.

Parameters:
ink  the RpToonInk to destroy.
Returns:
none.
See also:
RpToonInkAddRef , RpToonInkCreate
RwRGBA RpToonInkGetColor (  const RpToonInk *    ink ) 
 

RpToonInkGetColor is used to get an ink's color.

Parameters:
ink  A pointer to the ink.
Returns:
An RwRGBA representing the color.
See also:
RpToonInkGetColor
RwReal RpToonInkGetFarScale (  const RpToonInk *    ink ) 
 

RpToonInkGetFarScale is used to get an ink's far scale thickness.

Parameters:
ink  A pointer to the ink
Returns:
an RwReal representing the far scale thickness.
See also:
RpToonInkSetOverallThickness , RpToonInkSetPerspectiveScale , RpToonInkSetFarScale
const RwChar* RpToonInkGetName (  const RpToonInk *    ink ) 
 

RpToonInkGetName is used to get an ink's name. Ink names are used as keys in RpToonInkDictionary objects.

Parameters:
ink  A pointer to the ink.
Returns:
the inks name.
See also:
RpToonInkSetName
RwReal RpToonInkGetOverallThickness (  const RpToonInk *    ink ) 
 

RpToonInkGetOverallThickness is used to get an ink's thickness.

Parameters:
ink  A pointer to the ink
Returns:
an RwReal representing the base thickness.
See also:
RpToonInkSetOverallThickness , RpToonInkSetPerspectiveScale , RpToonInkSetFarScale
RwReal RpToonInkGetPerspectiveScale (  const RpToonInk *    ink ) 
 

RpToonInkGetPerspectiveScale is used to get an ink's perspective scale.

Parameters:
ink  A pointer to the ink
Returns:
an RwReal representing the perspective scale thickness.
See also:
RpToonInkSetOverallThickness , RpToonInkSetPerspectiveScale , RpToonInkSetFarScale
void RpToonInkSetColor (  RpToonInk *    ink,
RwRGBA    color
) 
 

RpToonInkSetColor is used to set an ink's color.

Parameters:
ink  A pointer to the ink.
color  An RwRGBA representing the new color.
Returns:
none.
See also:
RpToonInkGetColor
void RpToonInkSetFarScale (  RpToonInk *    ink,
RwReal    farScale
) 
 

RpToonInkSetFarScale is used to set an ink's thickness with an RpAtomics distance to the camera. When the object is at the far clip plane, the ink thickness is multiplied by this factor, and this falls off to a multiplier of 1 (no effect) as the object approaches the near clip plane. This is useful to prevent the lines around an object from growing bigger than the object itself as it moves away from the camera, which generally looks horrible. Toon rendered world sectors ignore this attribute.

Parameters:
ink  A pointer to the ink
farScale  an RwReal representing the far scale thickness.
Returns:
none.
See also:
RpToonInkGetOverallThickness , RpToonInkGetPerspectiveScale , RpToonInkGetFarScale
void RpToonInkSetName (  RpToonInk *    ink,
const RwChar *    name
) 
 

RpToonInkSetName is used to set an ink's name. Ink names are used as keys in RpToonInkDictionary objects.

Parameters:
ink  A pointer to the ink.
name  A string specifying the new name.
Returns:
none.
See also:
RpToonInkGetName
void RpToonInkSetOverallThickness (  RpToonInk *    ink,
RwReal    thickness
) 
 

RpToonInkSetOverallThickness is used to set an ink's thickness. Factors in the ink and toon geometry will be multiplied against this value when rendering to give the final thickness of a particular edge.

Parameters:
ink  A pointer to the ink
thickness  an RwReal representing the base thickness.
Returns:
none.
See also:
RpToonInkGetOverallThickness , RpToonInkGetPerspectiveScale , RpToonInkGetFarScale
void RpToonInkSetPerspectiveScale (  RpToonInk *    ink,
RwReal    perspectiveScale
) 
 

RpToonInkSetPerspectiveScale is used to affect an ink's thickness with distance to the camera per vertex. Lines near the camera will have their thicknesses multiplied by perspectiveScale. This will fall off to a multiplier of 1 (no effect) on lines far from the camera. For RpAtomics, these boundaries are at either extreme of the atomic's bound sphere. For world sectors, these boundaries are just the camera's clip planes. This is especially useful for landscapes or "forced perpective" on close ups of characters.

Parameters:
ink  A pointer to the ink
perspectiveScale  an RwReal representing the perspective scale thickness.
Returns:
none.
See also:
RpToonInkGetOverallThickness , RpToonInkGetPerspectiveScale , RpToonInkGetFarScale
RpToonInk* RpToonInkStreamRead (  RwStream *    stream ) 
 

RpToonInkStreamRead is used to read an ink from the specified binary stream.

Parameters:
stream  A pointer to the binary stream from which the ink will be read
Returns:
Returns a pointer to the ink if successful or NULL if there is an error
See also:
RpToonkInkStreamWrite
const RpToonInk* RpToonInkStreamWrite (  const RpToonInk *    ink,
RwStream *    stream
) 
 

RpToonInkStreamWrite is used to write the specified ink to the given binary stream. The stream must have been opened prior to this function call.

Parameters:
ink  A pointer to the ink to be written
stream  A pointer to the binary stream
Returns:
Returns a pointer to the ink if successful, or NULL if there is an error
See also:
RpToonInkStreamRead , RwStreamOpen , RwStreamClose
Criterion Software © 1993-2003 Criterion Software Limited. All rights reserved. Built Tue Apr 22 12:46:31 2003. Send Feedback
Converted from CHM to HTML with chm2web Pro 2.85 (unicode)