MDL SDK API nvidia_logo_transpbg.gif Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
itype.h
Go to the documentation of this file.
1 /***************************************************************************************************
2  * Copyright 2022 NVIDIA Corporation. All rights reserved.
3  **************************************************************************************************/
6 
7 #ifndef MI_NEURAYLIB_ITYPE_H
8 #define MI_NEURAYLIB_ITYPE_H
9 
11 
12 namespace mi {
13 
14 class IString;
15 
16 namespace neuraylib {
17 
44 class IAnnotation_block;
45 
49 class IType : public
50  mi::base::Interface_declare<0x242af675,0xeaa2,0x48b7,0x81,0x63,0xba,0x06,0xa5,0xfb,0x68,0xf0>
51 {
52 public:
54  enum Kind {
93  // Undocumented, for alignment only.
94  TK_FORCE_32_BIT = 0xffffffffU
95  };
96 
98  enum Modifier {
99  MK_NONE = 0,
102  MK_FORCE_32_BIT // Undocumented, for alignment only.
103  };
104 
106  virtual Kind get_kind() const = 0;
107 
115  virtual Uint32 get_all_type_modifiers() const = 0;
116 
122  virtual const IType* skip_all_type_aliases() const = 0;
123 };
124 
125 mi_static_assert( sizeof( IType::Kind) == sizeof( Uint32));
126 mi_static_assert( sizeof( IType::Modifier) == sizeof( Uint32));
127 
132 class IType_alias : public
133  mi::base::Interface_declare<0x69d8c70a,0xdfda,0x4e8e,0xaa,0x09,0x12,0x1f,0xa9,0x78,0xc6,0x6a,
134  neuraylib::IType>
135 {
136 public:
138  static const Kind s_kind = TK_ALIAS;
139 
141  virtual const IType* get_aliased_type() const = 0;
142 
144  virtual Uint32 get_type_modifiers() const = 0;
145 
147  virtual const char* get_symbol() const = 0;
148 };
149 
151 class IType_atomic : public
152  mi::base::Interface_declare<0x9d5f9116,0x3896,0x45c8,0xb4,0x5a,0x8b,0x03,0x84,0x49,0x0a,0x77,
153  neuraylib::IType>
154 {
155 };
156 
158 class IType_bool : public
159  mi::base::Interface_declare<0x831d8a38,0x26d3,0x4fd2,0xa7,0xf7,0x15,0xc2,0xa5,0x20,0x76,0x6c,
160  neuraylib::IType_atomic>
161 {
162 public:
164  static const Kind s_kind = TK_BOOL;
165 };
166 
168 class IType_int : public
169  mi::base::Interface_declare<0xbbad021c,0xbfe5,0x45de,0xaf,0x66,0xfd,0xe8,0x45,0xbe,0x48,0x49,
170  neuraylib::IType_atomic>
171 {
172 public:
174  static const Kind s_kind = TK_INT;
175 };
176 
178 class IType_enum : public
179  mi::base::Interface_declare<0x0e5b167c,0x9c3e,0x48bf,0xb5,0xfd,0x37,0x96,0xaa,0x47,0xaf,0xd1,
180  neuraylib::IType_atomic>
181 {
182 public:
185  EID_USER = -1,
188  EID_FORCE_32_BIT = 0x7fffffff // Undocumented, for alignment only.
189  };
190 
192  static const Kind s_kind = TK_ENUM;
193 
195  virtual const char* get_symbol() const = 0;
196 
198  virtual Size get_size() const = 0;
199 
204  virtual const char* get_value_name( Size index) const = 0;
205 
213  virtual Sint32 get_value_code( Size index, Sint32* errors = 0) const = 0;
214 
219  virtual Size find_value( const char* name) const = 0;
220 
225  virtual Size find_value( Sint32 code) const = 0;
226 
228  virtual Predefined_id get_predefined_id() const = 0;
229 
234  virtual const IAnnotation_block* get_annotations() const = 0;
235 
241  virtual const IAnnotation_block* get_value_annotations( Size index) const = 0;
242 };
243 
244 mi_static_assert( sizeof( IType_enum::Predefined_id) == sizeof( Uint32));
245 
247 class IType_float : public
248  mi::base::Interface_declare<0x613711b3,0x41f2,0x44a9,0xbb,0x78,0x43,0xe2,0x41,0x64,0xb3,0xda,
249  neuraylib::IType_atomic>
250 {
251 public:
253  static const Kind s_kind = TK_FLOAT;
254 };
255 
257 class IType_double : public
258  mi::base::Interface_declare<0xc381508b,0x7945,0x4c70,0x8a,0x20,0x57,0xd5,0x2b,0x36,0x35,0x40,
259  neuraylib::IType_atomic>
260 {
261 public:
263  static const Kind s_kind = TK_DOUBLE;
264 };
265 
267 class IType_string : public
268  mi::base::Interface_declare<0x4b4629bc,0xa2ce,0x4008,0xba,0x76,0xf6,0x4d,0x60,0x76,0x0a,0x85,
269  neuraylib::IType_atomic>
270 {
271 public:
273  static const Kind s_kind = TK_STRING;
274 };
275 
277 class IType_compound : public
278  mi::base::Interface_declare<0xc9ca497f,0xc38b,0x411f,0xa8,0x16,0xa7,0xd8,0x23,0x28,0xa5,0x40,
279  neuraylib::IType>
280 {
281 public:
283  virtual const IType* get_component_type( Size index) const = 0;
284 
286  virtual Size get_size() const = 0;
287 };
288 
293 class IType_vector : public
294  mi::base::Interface_declare<0x412a8a91,0x9062,0x46fd,0xaa,0xcf,0x46,0xbd,0xb3,0xde,0x5b,0x9c,
295  neuraylib::IType_compound>
296 {
297 public:
299  static const Kind s_kind = TK_VECTOR;
300 
307  virtual const IType_atomic* get_element_type() const = 0;
308 };
309 
321 class IType_matrix : public
322  mi::base::Interface_declare<0x6b76570e,0x51b2,0x4e9b,0x9f,0xe7,0xda,0x03,0x1c,0x37,0xbc,0x75,
323  neuraylib::IType_compound>
324 {
325 public:
327  static const Kind s_kind = TK_MATRIX;
328 
330  virtual const IType_vector* get_element_type() const = 0;
331 };
332 
336 class IType_color : public
337  mi::base::Interface_declare<0xedb16770,0xdf70,0x4def,0x83,0xa5,0xc4,0x4f,0xcd,0x09,0x47,0x0f,
338  neuraylib::IType_compound>
339 {
340 public:
342  static const Kind s_kind = TK_COLOR;
343 };
344 
346 class IType_array : public
347  mi::base::Interface_declare<0x21ab6abe,0x0e26,0x40da,0xa1,0x98,0x42,0xc0,0x89,0x71,0x5d,0x2a,
348  neuraylib::IType_compound>
349 {
350 public:
352  static const Kind s_kind = TK_ARRAY;
353 
355  virtual const IType* get_element_type() const = 0;
356 
358  virtual bool is_immediate_sized() const = 0;
359 
361  virtual Size get_size() const = 0;
362 
367  virtual const char* get_deferred_size() const = 0;
368 };
369 
371 class IType_struct : public
372  mi::base::Interface_declare<0x19566cb2,0x0b5d,0x41ca,0xa0,0x31,0x96,0xe2,0x9a,0xd4,0xc3,0x1a,
373  neuraylib::IType_compound>
374 {
375 public:
378  SID_USER = -1,
384  SID_FORCE_32_BIT = 0x7fffffff // Undocumented, for alignment only.
385  };
386 
388  static const Kind s_kind = TK_STRUCT;
389 
391  virtual const char* get_symbol() const = 0;
392 
397  virtual const IType* get_field_type( Size index) const = 0;
398 
403  virtual const char* get_field_name( Size index) const = 0;
404 
409  virtual Size find_field( const char* name) const = 0;
410 
412  virtual Predefined_id get_predefined_id() const = 0;
413 
418  virtual const IAnnotation_block* get_annotations() const = 0;
419 
425  virtual const IAnnotation_block* get_field_annotations( Size index) const = 0;
426 };
427 
429 
431 class IType_reference : public
432  mi::base::Interface_declare<0x3e12cdec,0xdaba,0x460c,0x9e,0x8a,0x21,0x4c,0x43,0x9a,0x1a,0x90,
433  neuraylib::IType>
434 {
435 };
436 
438 class IType_resource : public
439  mi::base::Interface_declare<0x142f5bea,0x139e,0x42e4,0xb1,0x1c,0xb3,0x4d,0xd8,0xe3,0xd9,0x8d,
440  neuraylib::IType_reference>
441 {
442 };
443 
445 class IType_texture : public
446  mi::base::Interface_declare<0x2f11253f,0xb8ac,0x4b7d,0x8d,0xd6,0x43,0x66,0xf5,0x97,0xd0,0x93,
447  neuraylib::IType_resource>
448 {
449 public:
451  static const Kind s_kind = TK_TEXTURE;
452 
454  enum Shape {
455  TS_2D = 0,
456  TS_3D = 1,
457  TS_CUBE = 2,
458  TS_PTEX = 3,
460  TS_FORCE_32_BIT = 0xffffffffU // Undocumented, for alignment only.
462  };
463 
465  virtual Shape get_shape() const = 0;
466 };
467 
468 mi_static_assert( sizeof( IType_texture::Shape) == sizeof( Uint32));
469 
471 class IType_light_profile : public
472  mi::base::Interface_declare<0x11b80cd8,0x14aa,0x4dfa,0x8b,0xf6,0x0e,0x56,0x0f,0x10,0x9c,0x37,
473  neuraylib::IType_resource>
474 {
475 public:
477  static const Kind s_kind = TK_LIGHT_PROFILE;
478 };
479 
482  mi::base::Interface_declare<0xf061d204,0xc649,0x4a6b,0xb6,0x2d,0x67,0xe6,0x47,0x53,0xa9,0xda,
483  neuraylib::IType_resource>
484 {
485 public:
488 };
489 
491 class IType_df : public
492  mi::base::Interface_declare<0xf4bcba08,0x7777,0x4662,0x8e,0x29,0x67,0xe1,0x52,0xac,0x05,0x3e,
493  neuraylib::IType_reference>
494 {
495 };
496 
498 class IType_bsdf : public
499  mi::base::Interface_declare<0x6542a02c,0xe1d2,0x485d,0x9a,0x51,0x7b,0xed,0xff,0x7f,0x24,0x7b,
500  neuraylib::IType_df>
501 {
502 public:
504  static const Kind s_kind = TK_BSDF;
505 };
506 
508 class IType_hair_bsdf : public
509  mi::base::Interface_declare<0x8eac6c90,0x2b8f,0x4650,0x8b,0x93,0x88,0xe0,0x42,0xff,0x19,0x9c,
510  neuraylib::IType_df>
511 {
512 public:
514  static const Kind s_kind = TK_HAIR_BSDF;
515 };
516 
518 class IType_edf : public
519  mi::base::Interface_declare<0x3e3ce697,0xa2a7,0x43ef,0xa2,0xec,0x52,0x5a,0x4c,0x27,0x8f,0xeb,
520  neuraylib::IType_df>
521 {
522 public:
524  static const Kind s_kind = TK_EDF;
525 };
526 
528 class IType_vdf : public
529  mi::base::Interface_declare<0x44782b21,0x9e60,0x40b2,0xba,0xae,0x41,0x74,0xc9,0x98,0xe1,0x86,
530  neuraylib::IType_df>
531 {
532 public:
534  static const Kind s_kind = TK_VDF;
535 };
536 
540 class IType_list : public
541  mi::base::Interface_declare<0x68a97390,0x22ea,0x4f03,0xa5,0xb5,0x5c,0x18,0x32,0x38,0x28,0x91>
542 {
543 public:
545  virtual Size get_size() const = 0;
546 
548  virtual Size get_index( const char* name) const = 0;
549 
551  virtual const char* get_name( Size index) const = 0;
552 
554  virtual const IType* get_type( Size index) const = 0;
555 
557  template <class T>
558  const T* get_type( Size index) const
559  {
560  const IType* ptr_type = get_type( index);
561  if( !ptr_type)
562  return 0;
563  const T* ptr_T = static_cast<const T*>( ptr_type->get_interface( typename T::IID()));
564  ptr_type->release();
565  return ptr_T;
566  }
567 
569  virtual const IType* get_type( const char* name) const = 0;
570 
572  template <class T>
573  const T* get_type( const char* name) const
574  {
575  const IType* ptr_type = get_type( name);
576  if( !ptr_type)
577  return 0;
578  const T* ptr_T = static_cast<const T*>( ptr_type->get_interface( typename T::IID()));
579  ptr_type->release();
580  return ptr_T;
581  }
582 
588  virtual Sint32 set_type( Size index, const IType* type) = 0;
589 
595  virtual Sint32 set_type( const char* name, const IType* type) = 0;
596 
602  virtual Sint32 add_type( const char* name, const IType* type) = 0;
603 };
604 
608 class IType_factory : public
609  mi::base::Interface_declare<0x353803c0,0x74a6,0x48ac,0xab,0xa1,0xe4,0x25,0x42,0x1d,0xa1,0xbc>
610 {
611 public:
613  virtual const IType_alias* create_alias(
614  const IType* type, Uint32 modifiers, const char* symbol) const = 0;
615 
617  virtual const IType_bool* create_bool() const = 0;
618 
620  virtual const IType_int* create_int() const = 0;
621 
623  virtual const IType_enum* create_enum( const char* symbol) const = 0;
624 
626  virtual const IType_float* create_float() const = 0;
627 
629  virtual const IType_double* create_double() const = 0;
630 
632  virtual const IType_string* create_string() const = 0;
633 
641  virtual const IType_vector* create_vector(
642  const IType_atomic* element_type, Size size) const = 0;
643 
650  virtual const IType_matrix* create_matrix(
651  const IType_vector* column_type, Size columns) const = 0;
652 
654  virtual const IType_color* create_color() const = 0;
655 
658  const IType* element_type, Size size) const = 0;
659 
662  const IType* element_type, const char* size) const = 0;
663 
665  virtual const IType_struct* create_struct( const char* symbol) const = 0;
666 
668  virtual const IType_texture* create_texture( IType_texture::Shape shape) const = 0;
669 
671  virtual const IType_light_profile* create_light_profile() const = 0;
672 
674  virtual const IType_bsdf_measurement* create_bsdf_measurement() const = 0;
675 
677  virtual const IType_bsdf* create_bsdf() const = 0;
678 
680  virtual const IType_hair_bsdf* create_hair_bsdf() const = 0;
681 
683  virtual const IType_edf* create_edf() const = 0;
684 
686  virtual const IType_vdf* create_vdf() const = 0;
687 
689  virtual IType_list* create_type_list() const = 0;
690 
692  virtual const IType_enum* get_predefined_enum( IType_enum::Predefined_id id) const = 0;
693 
695  virtual const IType_struct* get_predefined_struct( IType_struct::Predefined_id id) const = 0;
696 
698  virtual IType_list* clone( const IType_list* type_list) const = 0;
699 
723  virtual Sint32 compare( const IType* lhs, const IType* rhs) const = 0;
724 
738  virtual Sint32 compare( const IType_list* lhs, const IType_list* rhs) const = 0;
739 
761  virtual Sint32 is_compatible(const IType* src, const IType* dst) const = 0;
762 
772  virtual const IString* dump( const IType* type, Size depth = 0) const = 0;
773 
783  virtual const IString* dump( const IType_list* list, Size depth = 0) const = 0;
784 };
785  // end group mi_neuray_mdl_types
787 
788 } // namespace neuraylib
789 
790 } // namespace mi
791 
792 #endif // MI_NEURAYLIB_ITYPE_H