OpenGLPrakt --> cObject --> cVisibleObject --> cInteractiveObject --> cPlane

class cPlane
    extends cInteractiveObject as public

Simple plane object.

This object displays a simple plane, either solid or wireframed. Further, a display list is used to draw the plane. The plane starts at (-size_x/2,-size_y/2,0) and extends to (size_x/2, size_y/2, 0) Texture coordinates are generated also. (default: (0.0,0.0)-(1.0,1.0))

Source:
../src/cPlane.hh:29

Constructors Index

cPlane
[public] default constructor w/ optional object name
cPlane
[public] constructor w/ optional size and object name
cPlane
[public] default constructor
cPlane
[public] default constructor
~cPlane
[public] destructor


Enums Index

tePlaneType
[public] an enum to describe the plane's type (solid or wireframed)


Variables Index

mDisplayList
[protected] ID of display list which contains the plane
mResolution
[protected] resolution of plane, if given
mSizeX
[protected] side length of plane
mSizeY
[protected]
mSolid
[protected] Is the plane solid or wireframed?
mTexFromX
[protected] texture domain to use
mTexFromY
[protected]
mTexToX
[protected]
mTexToY
[protected]


Methods Index

DrawThisObject
[protected] drawing function
GetDefaultName
[protected] return class name
Init
[public] initialization function
MakeSolidPlane
[protected] create solid plane at given resolution
MakeWirePlane
[protected] create wire framed plane at given resolution
SetTextureDomain
[public] set texture coordinates to use


Constructors

cPlane

public cPlane ( cEventDispatcher * disp ,
                const char * name = NULL ) ;

default constructor w/ optional object name

Parameters:
name name of object (optional)

cPlane

public cPlane ( cEventDispatcher * disp ,
                GLdouble size_x ,
                GLdouble size_y ,
                const char * name = NULL ) ;

constructor w/ optional size and object name

Parameters:
size_x (GLdouble) x side length of plane (default: 1.0)
size_y (GLdouble) y side length of plane (default: 1.0)
name name of object (optional)

cPlane

public cPlane ( cEventDispatcher * disp ,
                GLdouble size_x ,
                GLdouble size_y ,
                tePlaneType solid ,
                const char * name = NULL ) ;

default constructor

Parameters:
size_x (GLdouble) x side length of plane (default: 1.0)
size_y (GLdouble) y side length of plane (default: 1.0)
solid (tePlaneType) draw solid or wireframe plane (default: solid)
name name of object (optional)

cPlane

public cPlane ( cEventDispatcher * disp ,
                GLdouble size_x ,
                GLdouble size_y ,
                tePlaneType solid ,
                int resolution ,
                const char * name = NULL ) ;

default constructor

Parameters:
size_x (GLdouble) x side length of plane (default: 1.0)
size_y (GLdouble) y side length of plane (default: 1.0)
solid (tePlaneType) draw solid or wireframe plane (default: solid)
resolution subdivisions per side
name name of object (optional)

cPlane

public virtual ~ cPlane ( ) ;

destructor


Enums

tePlaneType

public enum tePlaneType { PLANE_SOLID ,
                          PLANE_WIREFRAMED } ;

an enum to describe the plane's type (solid or wireframed)


Variables

mDisplayList

protected GLuint mDisplayList

ID of display list which contains the plane

mSolid

protected tePlaneType mSolid

Is the plane solid or wireframed?

mSizeX

protected GLdouble mSizeX

side length of plane

mSizeY

protected GLdouble mSizeY

mResolution

protected int mResolution

resolution of plane, if given

mTexFromX

protected GLfloat mTexFromX

texture domain to use

mTexToX

protected GLfloat mTexToX

mTexFromY

protected GLfloat mTexFromY

mTexToY

protected GLfloat mTexToY


Methods

Init

public virtual int Init ( ) ;

initialization function

SetTextureDomain

public virtual void SetTextureDomain ( GLfloat x_min ,
                                       GLfloat x_max ,
                                       GLfloat y_min ,
                                       GLfloat y_max ) ;

set texture coordinates to use

Parameters:
x_min from-x
x_max to-x
y_min from-y
y_max to-y

DrawThisObject

protected virtual void DrawThisObject ( ) ;

drawing function

GetDefaultName

protected virtual const char * GetDefaultName ( ) const ;

return class name

MakeSolidPlane

protected virtual void MakeSolidPlane ( ) ;

create solid plane at given resolution

MakeWirePlane

protected virtual void MakeWirePlane ( ) ;

create wire framed plane at given resolution


This documentation was generated automatically by the ccdoc tool (version 0.7a).
Click here to submit a bug report or feature request.

Click here to return to the top of the page.