Function


mhcModuleInit

Initializes MhcModule

Syntax

#include <mhc/Module.h>
void mhcModuleInit( MhcModule *module_ptr )

Description

Initializes MhcModule

See Also

MhcModule

mhcModuleDestroy

Destroys MhcModule

Syntax

#include <mhc/Module.h>
void mhcModuleDestroy( MhcModule *module_ptr )

Description

Destroys MhcModule

mhcModuleBeginEval

Initializes for evaluating MhcModule

Syntax

#include <mhc/Module.h>
void mhcModuleBeginEval( MhcModule *module_ptr )

Description

Initializes for evaluating MhcModule

mhcModuleGetExternalNode

Resolves external reference node

Syntax

#include <mhc/Module.h>
MhcNode *mhcModuleGetExternalNode( MhcModule *module_ptr,
                                   MhcScene *scene_ptr,
                                   const u32 index )

Description

Resolves external reference node

mhcModuleGetNodeByName

Searches for a node specified by its name

Syntax

#include <mhc/Module.h>
MhcNode *mhcModuleGetNodeByName( MhcModule *module_ptr,
                                 const char *node_name )

Description

Searches for a node specified by its name

mhcModuleGetNodeByType

Returns the number of specified nodes by type

Syntax

#include <mhc/Module.h>
u32 mhcModuleGetNodeByType( MhcModule *module_ptr,
                            const u32 type,
                            const u32 array_size,
                            MhcNode **node_ptr_array )

Description

Returns the number of specified nodes by type

mhcModuleActivate

Activates MhcModule

Syntax

#include <mhc/Module.h>
void mhcModuleActivate( MhcModule *module_ptr )

Description

Activates MhcModule

mhcModuleInactivate

Inactivates MhcModule

Syntax

#include <mhc/Module.h>
void mhcModuleInactivate( MhcModule *module_ptr )

Description

Inactivates MhcModule

mhcModuleBind

Binds Module with scene.

Syntax

#include <mhc/Module.h>
void mhcModuleBind( MhcModule *module_ptr,
                    MhcScene *scene_ptr )

Description

Binds Module with scene, which makes all the module pointers available.

See Also

MhcScene

mhcModuleLoad

Imports Module

Syntax

#include <mhc/Module.h>
int mhcModuleLoad( MhcModule *module_ptr,
                   MifFileParser *file_parser_ptr,
                   MisInput *input_ptr )

Description

Imports Module

See Also

MifFileParser MisInput

mhcModuleUnload

Deletes the contents of module that has been imported

Syntax

#include <mhc/Module.h>
int mhcModuleUnload( MhcModule *module_ptr );

Description

Deletes the contents of module that has been imported

Macro



_mhcModuleIsActive

Checks if Module is active

Syntax

#include <mhc/Module.h>
_mhcModuleIsActive(module_ptr)

Description

Checks if Module is active

_mhcModuleGetNodeByIndex

Searches for a node specified by Index

Syntax

#include <mhc/Module.h>
_mhcModuleGetNodeByIndex(module_ptr,index)

Description

Searches for a node specified by Index

_mhcModuleAddNode

Adds a node to Module

Syntax

#include <mhc/Module.h>
_mhcModuleAddNode(module_ptr,node_ptr)

Description

Adds a node to Module

Structure



MhcModule


#include <mhc/Module.h>

typedef struct _MhcModule
{
    u16                         status;
    u16                         is_active;
    u32                         max_nodes;
    u32                         number_of_nodes;
    struct _MhcNode             **node_ptr_array;
    u32                         number_of_root_nodes;
    struct _MhcNodeHandle       *root_node_handle_array;
    u32                         number_of_references;
    struct _MhcReference        *reference_array;
    char                        *symbol_table;
    u32                         number_of_external_nodes;
    struct _MhcExternalNode     *external_node_array;

    /* The following are only used in the flat mode.*/
    MvmMatrix33f                orientation;
    MvmMatrix33f                scaled_orientation;
    MvmVector3f                 translation;
} MhcModule;