SilverScreen Solid Modeler

primitive_plane

primitive_plane

Previous topic Next topic  

primitive_plane

Previous topic Next topic JavaScript is required for the print function  

SilverScreenAPI

 

int primitive_plane ( char *path, int id, SS_COEF *coef )

 

char    *path;       // path name of object

int      id;         // ID number of primitive

SS_COEF *coef;       // address of plane structure to receive result

 

 




Synopsis

#include "silver.h"

 

The primitive_plane function calculates the plane equation of the primitive with ID number id in object with path name path . The plane is returned in the SS_COEF structure at plane . If the primitive is a member of a solid, then the plane is oriented so that it faces out of the solid.

 

 

Parameters

path is a null-terminated string containing the full path name of the object that contains the primitive. id is is the primitive ID number of the primitive. coef is the address of an SS_COEF structure that is to receive the plane equation.

 

 

Return Value

primitive_plane returns one of:

 

Name

Meaning

SS_SUCCESS

function performed successfully

SS_NOTFOUND

specified primitive was not found

SS_FAILURE

a plane could not be computed

If SS_SUCCESS is returned, then the plane equation is stored into coef .

 

 

Comments

Note that the return values for this function are different from those returned in primitive_plane2.

 

 

See Also

primitive_plane2