datasettype.h

Go to the documentation of this file.

/*==============================================================================
                Copyright (c) 2003-2005 UGS Corporation
                   Unpublished - All Rights Reserved
 ==============================================================================*/

/*  */

#ifndef DATASETTYPE_H
#define DATASETTYPE_H

#define TEXT_REF        "TEXT"
#define BINARY_REF      "BINARY"
#define OBJECT_REF      "OBJECT"

#define AE_NOEXPORT 0
#define AE_EXPORT 1

/* ******************************************************** */
/*
** If you get these 'incompatibly defined' errors, then:
**
** 1a. Either move your #include datasettype.h directive ahead of the clashing
** product's #include directives
**
** 1b. Or move whichever #include is including datasettype.h or introduce a new
** #include datasettype.h ahead of the other product's #include.
**
** 2. Put #undef EXPORT immediately after the #include datasettype.h
**
** 3. Make sure that your code uses AE_EXPORT if it means AE_EXPORT. If you really
** want the other product's EXPORT, then use EXPORT.
*/

#ifdef EXPORT
#   error EXPORT is incompatibly defined; use AE_EXPORT and re-arrange includes
#else
#   define EXPORT AE_EXPORT
#endif
#ifdef NOEXPORT
#   error NOEXPORT is incompatibly defined; use AE_NOEXPORT and re-arrange includes
#else
#   define NOEXPORT AE_NOEXPORT
#endif

/* End deprecation.                                         */
/* ******************************************************** */

#include <ae/ae_types.h>
#include <tc/tc_startup.h>
#include <ae/libae_exports.h>

#ifdef __cplusplus
    extern "C"{
#endif

extern AE_API int AE_datasettype_extent(
    int*          n_instances,        
    tag_t**       instances           
    );

extern AE_API int AE_ask_datasettype_parent(
    tag_t         datasettype,         
    tag_t*        parent_type          
    );

extern AE_API int AE_ask_datasettype_def_tool(
    tag_t         datasettype,       
    tag_t*        tool               
    );

extern AE_API int AE_ask_datasettype_def_view_tool(
    tag_t         datasettype,       
    tag_t*        tool               
    );

extern AE_API int AE_ask_datasettype_name(
    tag_t         datasettype,                                       
    char          datasettype_name[AE_datasettype_name_size_c + 1]   
    );

extern AE_API int AE_ask_datasettype_name2(
    tag_t         datasettype,                                       
    char          **datasettype_name                                 
    );

extern AE_API int AE_ask_datasettype_desc(
    tag_t         datasettype,                                       
    char          datasettype_desc[AE_datasettype_desc_size_c + 1]   
    );


extern AE_API int AE_ask_datasettype_desc2(
    tag_t         datasettype,                                       
    char          **datasettype_desc                                 
    );

extern AE_API int AE_ask_datasettype_tools(
    tag_t         datasettype,         
    int*          tool_count,          
    tag_t**       tool_list            
    );

extern AE_API int AE_ask_datasettype_view_tools(
    tag_t         datasettype,         
    int*          tool_count,          
    tag_t**       tool_list            
    );

extern AE_API int AE_find_datasettype(
    const char    datasettype_name[AE_datasettype_name_size_c + 1],  
    tag_t*        datasettype                                        
    );


extern AE_API int AE_find_datasettype2(
    const char    *datasettype_name,                                 
    tag_t*        datasettype                                        
    );

extern AE_API int AE_ask_datasettype_children(
    tag_t         datasettype,        
    int*          child_count,        
    tag_t**       child_tags          
    );

extern AE_API int AE_ask_datasettype_action(
    tag_t         datasettype,        
    AE_action_t   action,             
    int*          on_or_off          
    );

extern AE_API int AE_init_datasettype_actions(
    tag_t         datasettype,        
    int           on_or_off           
    );

extern AE_API int AE_ask_datasettype_refs(
    tag_t         datasettype,        
    int*          ref_count,          
    char***       ref_list            
    );

extern AE_API int AE_ask_datasettype_file_refs(
    tag_t         datasettype,        
    const char*   ref_name,           
    int*          count,              
    char***       ref_templates,      
    char***       ref_formats         
    );

extern AE_API int AE_ask_tool_oper_refs(
    tag_t         dtag,           
    tag_t         tool,           
    int           oper_name,      
    int*          no_refs,        
    char***       ref_names,      
    int**         export_flags    
    );

extern AE_API int AE_ask_tool_oper_params(
    tag_t         dtag,         
    tag_t         tool,         
    int           oper_name,    
    int*          no_params,    
    char***       param_names   
    );

extern AE_API int AE_ask_oper_preaction(
    tag_t         dtag,             
    tag_t         tool,             
    int           oper_name,        
    tag_t*        preaction_tool    
    );

extern AE_API int AE_ask_oper_postaction (
    tag_t         dtag,             
    tag_t         tool,             
    int           oper_name,        
    tag_t*        postaction_tool   
    );

extern AE_API int AE_ask_oper_preaction_params (
    tag_t         dtag,               
    tag_t         tool,               
    int           oper_name,          
    int*          no_params,          
    char***       param_names         
    );

extern AE_API int AE_ask_oper_postaction_params (
    tag_t         dtag,               
    tag_t         tool,               
    int           oper_name,          
    int*          no_params,          
    char***       param_names         
    );

#ifdef __cplusplus
}
#endif

#include <ae/libae_undef.h>
#endif