DI-Guy SDK Documentation  13.1
Public Member Functions | Static Public Attributes | List of all members
diguyOglGraphicsLink Class Reference
DI-Guy Graphics API OpenGl sample implementation

#include <diguyOglGraphicsLink.h>

Inheritance diagram for diguyOglGraphicsLink:
diguyGraphicsLink

Public Member Functions

 diguyOglGraphicsLink (void *internal_data)
 
virtual void begin_character_draw ()
 This function will be called by DI-Guy when the drawing of a new character is beginning. More...
 
virtual void end_character_draw ()
 This function will be called by DI-Guy when the drawing traversal of the character's link hierarchy has completed. More...
 
virtual void draw ()
 This function will be called by DI-Guy when it is time for the transformations of this link to be applied. More...
 
virtual void push ()
 This function will be called by DI-Guy when it is traversing the link hierarchy to draw. More...
 
virtual void pop ()
 This function will be called by DI-Guy when it is traversing the link hierarchy to draw. More...
 
- Public Member Functions inherited from diguyGraphicsLink
const char * get_name ()
 Returns the name of the link. More...
 
long get_uid ()
 All links are assigned a unique identifier, or uid. More...
 
int get_index ()
 Returns: index of the link. More...
 
diguyCharacter * get_character ()
 Returns a pointer to the diguyCharacter to which this link belongs. More...
 
int get_num_shapes ()
 Returns: number of shapes on this link. More...
 
diguyGraphicsShape * get_shape_at_index (int index)
 Returns: pointer of type diguyGraphicsShape; NULL if no shape at the specified index. More...
 
diguyGraphicsShape * find_shape (const char *name)
 This function returns a pointer to the specified shape. More...
 
diguyGraphicsShape * find_shape_by_class_type (const char *name)
 This function returns a pointer to the specified shape. More...
 
diguyGraphicsJointType get_joint_type ()
 Returns the type of joint that attaches this link to its parent. More...
 
int get_offset_translation (float *tx, float *ty, float *tz)
 Returns in the passed variables the translation offset of this link from its parent. More...
 
int get_offset_rotation (float *rz, float *rx, float *ry)
 Returns in the passed variables the rotational offset of this link from its parent. More...
 
int get_translation (float *tx, float *ty, float *tz)
 Returns in the passed variables the translation amount of the link's joint. More...
 
int get_translation_double (double *tx, double *ty, double *tz)
 Returns in the passed variables the translation amount of the link's joint. More...
 
int get_translation_is_static ()
 Returns whether the translation returned by get_translation() is static (unchanging) or dynamic (can change frame to frame). More...
 
const char * get_var_name_tx ()
 Returns the name of the DI-Guy motion data variable that controls translation along the X axis. More...
 
const char * get_var_name_ty ()
 Returns the name of the DI-Guy motion data variable that controls translation along the Y axis. More...
 
const char * get_var_name_tz ()
 Returns the name of the DI-Guy motion data variable that controls translation along the Z axis. More...
 
int get_rotation (float *rz, float *rx, float *ry)
 Returns in the passed variables the rotation amount of the link's joint. More...
 
int get_rotation_euler (float *rz, float *rx, float *ry)
 Returns in the passed variables the rotation amount of the link's joint. More...
 
int get_rotation_quat (float *qx, float *qy, float *qz, float *qw)
 Returns in the passed variables the rotation amount of the link's joint. More...
 
int get_rotation_is_static ()
 Returns whether the rotation returned by get_rotation() is static (unchanging) or dynamic (can change frame to frame). More...
 
const char * get_var_name_rz ()
 Returns the name of the DI-Guy motion data variable that controls rotation about the Z axis. More...
 
const char * get_var_name_rx ()
 Returns the name of the DI-Guy motion data variable that controls rotation about the X axis. More...
 
const char * get_var_name_ry ()
 Returns the name of the DI-Guy motion data variable that controls rotation about the Y axis. More...
 
int get_scale (float *sz, float *sx, float *sy)
 Returns in the passed variables the scale amount of the link's joint. More...
 
int get_scale_is_static ()
 Returns whether the scale returned by get_scale() is static (unchanging) or dynamic (can change frame to frame). More...
 
const char * get_var_name_sx ()
 Returns the name of the DI-Guy motion data variable that controls scale in the Z dimension. More...
 
const char * get_var_name_sy ()
 Returns the name of the DI-Guy motion data variable that controls scale in the Y dimension. More...
 
const char * get_var_name_sz ()
 Returns the name of the DI-Guy motion data variable that controls scale in the X dimension. More...
 
diguyGraphicsLink * get_parent_link ()
 Returns a pointer to this link's parent link. More...
 
diguyGraphicsLink * get_attached_to_link ()
 Returns a pointer to this link's attached to link. More...
 
int get_is_position_link ()
 Returns 1 if this link is the position link, or 0 if not. More...
 
int get_num_child_links ()
 Returns how many child links this link has. More...
 
diguyGraphicsLink * get_child_link_at_index (int index)
 Returns a pointer to this link's child link at the specified index. More...
 
int get_transformation_matrix (float matrix_array[4][4], int transpose=0)
 This function fills out the passed float array with the world-coordinate system transformation matrix of this link. More...
 
int get_transformation_matrix_4x4_ptr (float *matrix, int transpose=0)
 Pointer version of get_transformation_matrix(), see for docs. More...
 
int get_local_transformation_matrix (float matrix_array[4][4], int transpose=0)
 This function fills out the passed float array with the character-local-coordinate system transformation matrix of this link. More...
 
int get_local_transformation_matrix_4x4_ptr (float *matrix, int transpose=0)
 Pointer version of get_local_transformation_matrix(), see for docs. More...
 
int get_link_transformation_matrix (float matrix_array[4][4], int transpose=0)
 This function fills out the passed float array with the link-local-coordinate system transformation matrix of this link. More...
 
int get_link_transformation_matrix_4x4_ptr (float *matrix, int transpose=0)
 Pointer version of get_link_transformation_matrix(), see for docs. More...
 
const float * get_data_ptr ()
 Returns a pointer to the current motion data array. More...
 
const float * get_quat_data_ptr ()
 This function is similar to get_data_ptr(), except rotations in the returned array will be in quaternions instead of Euler angles. More...
 
int get_translation_data_index ()
 Returns the index of this link's translation data in the float array returned by get_data_ptr() or get_quat_data_ptr(). More...
 
int get_rotation_data_index ()
 Returns the index of this link's rotation data in the float array returned by get_data_ptr(). More...
 
int get_quat_data_index ()
 Returns the index of this link's rotation data in the float array returned by get_quat_data_ptr(). More...
 
int get_scale_data_index ()
 Returns the index of this link's scale data in the float array returned by get_data_ptr() or get_quat_data_ptr(). More...
 
int get_unique_color (unsigned char *r, unsigned char *g, unsigned char *b)
 Returns in the passed pointers the unique color of this link. More...
 
virtual void build ()
 This function will be called by DI-Guy when it is time for renderer-specific link objects to be created. More...
 
virtual void post_build ()
 This function will be called by DI-Guy when all links and shapes of a DI-Guy character have been built, providing an opportunity for final touch-ups to be made to the built hierarchy. More...
 
virtual void unbuild ()
 This function will be called by DI-Guy when it is time for the renderer-specific link objects created during the build() call to be destroyed. More...
 
virtual void attach_to_scene ()
 This function will be called by DI-Guy when it is time for renderer-specific link objects created during the build() call to be attached to their attach points. More...
 
virtual void detach_from_scene ()
 This function will be called by DI-Guy when it is time for renderer-specific link objects created during the build() call to be detached from their attach points. More...
 
virtual void instancing_state_changed (int instanced)
 TODO MARCM. More...
 
virtual void update ()
 This function will be called by DI-Guy when it is time for renderer-specific link objects created during the build() call to be updated with new transformation data. More...
 
virtual void set_shader_instance (diguyGraphicsShaderInstance *shader_instance)
 This function will be called by DI-Guy when it a shader should be bound to this link. More...
 
int get_is_base_link ()
 Deprecated as of 9.1.4; use diguyGraphicsLink::get_is_position_link() instead. More...
 
int get_shader_matrix_index ()
 Deprecated as of 12.0.0 due to architecture change. More...
 
int get_inverse_rotation_matrix (float matrix_array[4][4], int transpose=0, int include_translation=1)
 
int get_inverse_rotation_matrix_4x4_ptr (float *matrix_array, int transpose=0, int include_translation=1)
 
bdiLink * get_scripted_object ()
 

Static Public Attributes

static int s_num_chars_drawn = 0
 

Additional Inherited Members

- Static Public Member Functions inherited from diguyGraphicsLink
static void set_use_linear_traversal_draw (int mode)
 This value corresponds to bdiGraphicsInitGraphicsAPI.use_linear_traversal_draw. More...
 
static int get_use_linear_traversal_draw ()
 This is always true as of DI-Guy 13. More...
 
- Protected Member Functions inherited from diguyGraphicsLink
 diguyGraphicsLink (void *internal_data)
 A protected constructor. More...
 
virtual ~diguyGraphicsLink ()
 A protected destructor. More...
 

Constructor & Destructor Documentation

diguyOglGraphicsLink::diguyOglGraphicsLink ( void *  internal_data)

Member Function Documentation

void diguyOglGraphicsLink::begin_character_draw ( )
virtual

This function will be called by DI-Guy when the drawing of a new character is beginning.

This happens when the position link is drawn.

Immediate Mode:

Immediate mode renderers can override this function. Typically some type of transformation matrix stack push operation is performed. This is also an appropriate place to do any per-character modifications, such as:

  • applying scale
  • applying the base translation of the character
  • picking a current LOD
  • etc.

Scene Graph:

Scene graph renderers usually do not override this function; transformation states are handled automatically by scene graphs.

Callable From:

  • N/A (automatically called by DI-Guy Graphics API during Draw Stage)

Reimplemented from diguyGraphicsLink.

void diguyOglGraphicsLink::end_character_draw ( )
virtual

This function will be called by DI-Guy when the drawing traversal of the character's link hierarchy has completed.

Immediate Mode:

Immediate mode renderers can override this function. Typically any matrix stack push operation done in begin_character_draw() is undone here by an appropriate pop operation.

Scene Graph:

Scene graph renderers usually do not override this function; transformation states are handled automatically by scene graphs.

Callable From:

  • N/A (automatically called by DI-Guy Graphics API during Draw Stage)

Reimplemented from diguyGraphicsLink.

void diguyOglGraphicsLink::draw ( )
virtual

This function will be called by DI-Guy when it is time for the transformations of this link to be applied.

Immediate Mode:

Immediate mode renderers usually do override this function, to apply transformations to the transformation stack.

Scene Graph:

Scene graph renderers usually do not override this function; transformation states are handled automatically by scene graphs.

Callable From:

  • N/A (automatically called by DI-Guy Graphics API during Draw Stage)

Reimplemented from diguyGraphicsLink.

void diguyOglGraphicsLink::push ( )
virtual

This function will be called by DI-Guy when it is traversing the link hierarchy to draw.

Immediate Mode:

Immediate mode renderers can override this function. Typically some type of transformation matrix stack push operation is performed.

Scene Graph:

Scene graph renderers usually do not override this function; transformation states are handled automatically by scene graphs.

Callable From:

  • N/A (automatically called by DI-Guy Graphics API during Draw Stage)

Reimplemented from diguyGraphicsLink.

void diguyOglGraphicsLink::pop ( )
virtual

This function will be called by DI-Guy when it is traversing the link hierarchy to draw.

Immediate Mode:

Immediate mode renderers can override this function. Typically some type of transformation matrix stack pop operation is performed.

Scene Graph:

Scene graph renderers usually do not override this function; transformation states are handled automatically by scene graphs.

Callable From:

  • N/A (automatically called by DI-Guy Graphics API during Draw Stage)

Reimplemented from diguyGraphicsLink.

Member Data Documentation

int diguyOglGraphicsLink::s_num_chars_drawn = 0
static
The documentation for this class was generated from the following files: