HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
COP_Signature.h File Reference
#include "COP_API.h"
#include <OP/OP_DataTypes.h>
#include <UT/UT_Array.h>
#include <UT/UT_StringHolder.h>
+ Include dependency graph for COP_Signature.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  COP_Signature
 

Enumerations

enum  COP_Type {
  COP_TYPE_UNDEF = 0, COP_TYPE_METADATA, COP_TYPE_INT, COP_TYPE_FLOAT,
  COP_TYPE_VECTOR2, COP_TYPE_VECTOR, COP_TYPE_VECTOR4, COP_TYPE_GEO,
  COP_TYPE_VDB_INT, COP_TYPE_VDB_FLOAT, COP_TYPE_VDB_VECTOR, COP_TYPE_CABLE
}
 Types of basic data that are passed around a COP network. More...
 

Functions

COP_API bool COPtypeIsConvertible (COP_Type src, COP_Type dst)
 Returns true if src is implicitly convertible to dst. More...
 
COP_API bool COPtypeIsApexConvertible (COP_Type src, COP_Type dst)
 
COP_API const char * COPtypeLabel (COP_Type t)
 Returns the English label for a type. More...
 
COP_API COP_Type COPtypeFromLabel (const char *label)
 Returns a type corresponding to the given English label. More...
 
COP_API int COPtypeChannels (const COP_Type t)
 Returns the number of channels for a type. More...
 
COP_API bool COPtypeIsLayer (COP_Type t)
 Returns true if this is a layer type. More...
 
COP_API bool COPtypeIsLayerOrUndef (COP_Type t)
 
COP_API bool COPtypeIsGeo (COP_Type t)
 
COP_API bool COPtypeIsVDB (COP_Type t)
 
COP_API COP_Type COPtype (const COP_PortData &, int index=0)
 Type of data that was output by a COP_Verb. More...
 
COP_API COP_Type COPtype (const IMX_Layer &)
 Type of data for the given layer. More...
 
COP_API COP_Type COPtype (const IMX_VDB &)
 Type of data for the given vdb. More...
 
COP_API size_t format (char *buffer, size_t buffer_size, const UT_Array< COP_Signature > &v)
 
COP_API size_t format (char *buffer, size_t buffer_size, const COP_Signature &v)
 
COP_API size_t format (char *buffer, size_t buffer_size, const COP_Type &v)
 

Enumeration Type Documentation

enum COP_Type

Types of basic data that are passed around a COP network.

Enumerator
COP_TYPE_UNDEF 
COP_TYPE_METADATA 
COP_TYPE_INT 
COP_TYPE_FLOAT 
COP_TYPE_VECTOR2 
COP_TYPE_VECTOR 
COP_TYPE_VECTOR4 
COP_TYPE_GEO 
COP_TYPE_VDB_INT 
COP_TYPE_VDB_FLOAT 
COP_TYPE_VDB_VECTOR 
COP_TYPE_CABLE 

Definition at line 17 of file COP_Signature.h.

Function Documentation

COP_API COP_Type COPtype ( const COP_PortData &  ,
int  index = 0 
)

Type of data that was output by a COP_Verb.

COP_API COP_Type COPtype ( const IMX_Layer )

Type of data for the given layer.

COP_API COP_Type COPtype ( const IMX_VDB )

Type of data for the given vdb.

COP_API int COPtypeChannels ( const COP_Type  t)
inline

Returns the number of channels for a type.

Definition at line 45 of file COP_Signature.h.

COP_API COP_Type COPtypeFromLabel ( const char *  label)

Returns a type corresponding to the given English label.

COP_API bool COPtypeIsApexConvertible ( COP_Type  src,
COP_Type  dst 
)

Returns true if src is implicitly convertible to dst in Apex, where layers and vdbs are indistinguishable for callbacks..

COP_API bool COPtypeIsConvertible ( COP_Type  src,
COP_Type  dst 
)

Returns true if src is implicitly convertible to dst.

COP_API bool COPtypeIsGeo ( COP_Type  t)
COP_API bool COPtypeIsLayer ( COP_Type  t)

Returns true if this is a layer type.

COP_API bool COPtypeIsLayerOrUndef ( COP_Type  t)
COP_API bool COPtypeIsVDB ( COP_Type  t)
COP_API const char* COPtypeLabel ( COP_Type  t)

Returns the English label for a type.

COP_API size_t format ( char *  buffer,
size_t  buffer_size,
const UT_Array< COP_Signature > &  v 
)
COP_API size_t format ( char *  buffer,
size_t  buffer_size,
const COP_Signature v 
)
COP_API size_t format ( char *  buffer,
size_t  buffer_size,
const COP_Type v 
)