ogltk_view

struct ogltk_view

struct ogltk_view {

    GtkDrawingArea      parent_instance;
    
    ogltk_scene         *scene;
    
    OGLTKConfigMode     config_mode;
    OGLTKRenderType     render_mode;
    gboolean            direct;         /* Should use direct connection to graphics system */
    
    gltTranslate        translate;
    gltRotate           rotate;
    gltColor            background;
    
    gboolean            light_enabled;
    OgltkFace           light_polygon_faces;
    OgltkMaterialMode   light_material;
    
};

enum OGLTKConfigMode

typedef enum
{
    OGLTK_CONFIG_RGB          = GDK_GL_MODE_RGB,        /* 0 */
    OGLTK_CONFIG_RGBA         = GDK_GL_MODE_RGBA,       /* same as RGB */
    OGLTK_CONFIG_INDEX        = GDK_GL_MODE_INDEX,      
    OGLTK_CONFIG_SINGLE       = GDK_GL_MODE_SINGLE,
    OGLTK_CONFIG_DOUBLE       = GDK_GL_MODE_DOUBLE,
    OGLTK_CONFIG_STERO        = GDK_GL_MODE_STEREO,
    OGLTK_CONFIG_ALPHA        = GDK_GL_MODE_ALPHA,
    OGLTK_CONFIG_DEPTH        = GDK_GL_MODE_DEPTH,
    OGLTK_CONFIG_STENCIL      = GDK_GL_MODE_STENCIL,
    OGLTK_CONFIG_ACCUM        = GDK_GL_MODE_ACCUM,
    OGLTK_CONFIG_MULTISAMPLE  = GDK_GL_MODE_MULTISAMPLE

} OGLTKConfigMode;

enum OGLTKRenderType

typedef enum
{
    OGLTK_RENDER_RGBA       = GDK_GL_RGBA_TYPE,
    OGLTK_RENDER_INDEX      = GDK_GL_COLOR_INDEX_TYPE
    
} OGLTKRenderType;

enum OgltkFace

typedef enum
{
    OGLTK_FACE_FRONT            = GL_FRONT,
    OGLTK_FACE_BACK             = GL_BACK,
    OGLTK_FACE_FRONT_AND_BACK   = GL_FRONT_AND_BACK,

}OgltkFace;

enum OgltkMaterialMode

typedef enum
{
    OGLTK_MAT_NONE                  = 0,
    OGLTK_MAT_AMBIENT               = GL_AMBIENT,
    OGLTK_MAT_DIFFUSE               = GL_DIFFUSE,
    OGLTK_MAT_SPECULAR              = GL_SPECULAR,
    OGLTK_MAT_EMISION               = GL_EMISSION,
    OGLTK_MAT_AMBIENT_AND_DIFFUSE   = GL_AMBIENT_AND_DIFFUSE,
    OGLTK_MAT_LAST                  = (OGLTK_MAT_AMBIENT_AND_DIFFUSE + 1),

}OgltkMaterialMode;

ogltk_view_get_width ()

gint        ogltk_view_get_width            (ogltk_view *view);

Gets the width of the view window.

ogltk_view_get_height ()

gint        ogltk_view_get_height           (ogltk_view *view);

Gets the height of the view window.

ogltk_view_set_translate_matrix ()

gboolean    ogltk_view_set_translate_matrix (ogltk_view *view,
                                             gfloat x,
                                             gfloat y,
                                             gfloat z);

Set the view location in the 3D world.

ogltk_view_enable_rotate_matrix ()

gboolean    ogltk_view_enable_rotate_matrix (ogltk_view *view);

Enable the rotation matrix for the view.

ogltk_view_set_rotate_matrix ()

gboolean    ogltk_view_set_rotate_matrix    (ogltk_view *view,
                                             gfloat angle,
                                             gfloat x,
                                             gfloat y,
                                             gfloat z);

Rotate the view on the value set in angle and apply this rotation on x,y and z axis'. One or all axis' can be enabled by setting to 1 or disabling with 0. The rotation matrix is disabled by default and either has to be enabled by ogltk_view_set_rotate_matrix_and_enable or ogltk_view_enable_rotate_matrix

ogltk_view_set_rotate_matrix_and_enable ()

gboolean    ogltk_view_set_rotate_matrix_and_enable
                                            (ogltk_view *view,
                                             gfloat angle,
                                             gfloat x,
                                             gfloat y,
                                             gfloat z);

Rotate the view on the value set in angle and apply this rotation on x,y and z axis'. One or all axis' can be enabled by setting to 1 or disabling with 0. This function will automatically enable this matrix to be calculated during rendering.

ogltk_view_disable_rotate_matrix ()

gboolean    ogltk_view_disable_rotate_matrix
                                            (ogltk_view *view);

Disables the rotation matrix for the view.

ogltk_view_update_rotate_matrix_angle ()

gboolean    ogltk_view_update_rotate_matrix_angle
                                            (ogltk_view *view,
                                             gfloat angle);

Rotate the view on the value set in angle and apply this rotation to x,y and z axis'. which were previously set by ogltk_view_set_rotate_matrix or ogltk_view_set_rotate_matrix and_enable.

ogltk_view_get_translate_matrix ()

const gltTranslate* ogltk_view_get_translate_matrix
                                            (ogltk_view *view);

Retrive the translation matrix type from the view.

ogltk_view_get_rotate_matrix ()

const gltRotate* ogltk_view_get_rotate_matrix
                                            (ogltk_view *view);

Retrieve the rotation matrix type for the view.

ogltk_view_set_config_mode ()

gboolean    ogltk_view_set_config_mode      (ogltk_view *view,
                                             OGLTKConfigMode config);

ogltk_view_enable_direct ()

gboolean    ogltk_view_enable_direct        (ogltk_view *view,
                                             gboolean enable);

ogltk_view_set_render_type ()

gboolean    ogltk_view_set_render_type      (ogltk_view *view,
                                             OGLTKRenderType config);

ogltk_view_update_capability ()

gboolean    ogltk_view_update_capability    (ogltk_view *view);

ogltk_view_draw_gl_begin ()

gboolean    ogltk_view_draw_gl_begin        (ogltk_view *view);

Enables drawing to the view widget.

ogltk_view_draw_gl_end ()

gboolean    ogltk_view_draw_gl_end          (ogltk_view *view);

Disables drawing to the view widget.

ogltk_view_swap_buffers ()

gboolean    ogltk_view_swap_buffers         (ogltk_view *view);

Swap to the next drawing buffer and render the previous.

ogltk_view_set_scene ()

gboolean    ogltk_view_set_scene            (ogltk_view *view,
                                             ogltk_scene *scene);

Bind a scene to the ogltk view. DEPRECIATED -> use ogltk_view_bind_scene instead

ogltk_view_bind_scene ()

gboolean    ogltk_view_bind_scene           (ogltk_view *view,
                                             ogltk_scene *scene);

Bind a scene to the ogltk view.

ogltk_view_get_scene ()

ogltk_scene* ogltk_view_get_scene           (ogltk_view *view);

Get the scene bound to the ogltk view.

ogltk_view_unbind_scene ()

gboolean    ogltk_view_unbind_scene         (ogltk_view *view);

UnBind a scene from the ogltk view.

ogltk_view_scene_is_bound ()

gboolean    ogltk_view_scene_is_bound       (ogltk_view *view);

Checks if a scene is bound to the view.

ogltk_view_render ()

gboolean    ogltk_view_render               (ogltk_view *view);

Render the view by translating and rotating it's location (view), as well as calling the scene render method if one is bound.

ogltk_view_set_background_color ()

gboolean    ogltk_view_set_background_color (ogltk_view *view,
                                             gfloat red,
                                             gfloat green,
                                             gfloat blue,
                                             gfloat alpha);

Set the default background color for the view

ogltk_view_enable_lighting ()

gboolean    ogltk_view_enable_lighting      (ogltk_view *view,
                                             gboolean enable);

Set whether or not the view is going to need/use lighting

ogltk_view_lighting_enabled ()

gboolean    ogltk_view_lighting_enabled     (ogltk_view *view);

Check if lighting is enabled.

ogltk_view_set_color_material ()

gboolean    ogltk_view_set_color_material   (ogltk_view *view,
                                             OgltkFace face,
                                             OgltkMaterialMode mode);

If lighting is enabled, then set the material properites of objects using the face and mode.