HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GA_Primitive.h
Go to the documentation of this file.
1 /*
2  * PROPRIETARY INFORMATION. This software is proprietary to
3  * Side Effects Software Inc., and is not to be reproduced,
4  * transmitted, or disclosed in any way without written permission.
5  *
6  * NAME: GA_Primitive.h (GA Library, C++)
7  *
8  * COMMENTS: Interface for primitives.
9  */
10 
11 #pragma once
12 
13 #ifndef __GA_Primitive__
14 #define __GA_Primitive__
15 
16 #define GA_PRIMITIVE_VERTEXLIST 1
17 
18 #include "GA_API.h"
19 #include "GA_Detail.h"
20 #include "GA_IntrinsicManager.h"
21 #include "GA_OffsetList.h"
22 #include "GA_PrimCompat.h"
23 #include "GA_PrimitiveDefinition.h"
24 #include "GA_PrimitiveFamilyMask.h"
25 #include "GA_PrimitiveTypeId.h"
26 #include "GA_SharedDataHandle.h"
27 #include "GA_SharedLoadData.h"
28 #include "GA_Range.h"
29 #include "GA_Topology.h"
30 #include "GA_Types.h"
31 
32 #include <UT/UT_BoundingBox.h>
33 #include <UT/UT_BoundingRect.h>
34 #include <UT/UT_Function.h>
35 #include <UT/UT_NonCopyable.h>
36 #include <UT/UT_VectorTypes.h>
37 #include <SYS/SYS_Inline.h>
38 #include <SYS/SYS_Types.h>
39 
40 #include <iosfwd>
41 #include <stddef.h>
42 
45 class GA_Attribute;
46 class GA_Defragment;
47 class GA_Detail;
48 class GA_IntrinsicEval;
49 class GA_MergeMap;
50 class GA_PrimitiveJSON;
51 class GA_PrimitiveList;
53 class GA_GeometryIndex;
54 
55 class UT_BoundingSphere;
56 class UT_IStream;
57 class UT_MemoryCounter;
58 class UT_Options;
59 class UT_String;
60 class UT_StringArray;
61 template <typename T> class UT_Array;
62 
63 template<typename T, bool B> class GA_EdgeT;
65 
66 
67 class GA_Primitive;
68 typedef void (* GA_EdgeApplyFunc)(const GA_Primitive &prim,
69  GA_Offset pt_a, GA_Offset pt_b, void *data);
70 typedef void (* GA_EdgeApplyIndexFunc)(const GA_Primitive &prim,
71  GA_Size v1, GA_Size v2, void *data);
72 
75 
76 #define GA_NO_OVERRIDE
77 
78 /// Declare intrinsic callback functions in header file. See
79 /// GA_IntrinsicMacros.h for macros to help implement intrinsics.
80 #define GA_DECLARE_INTRINSICS(OVERRIDE) \
81  static GA_IntrinsicManager::Registrar \
82  registerIntrinsics(GA_PrimitiveDefinition &); \
83  virtual GA_Size localIntrinsicTupleSize(const GA_IntrinsicEval &) const \
84  OVERRIDE; \
85  virtual GA_Size localGetIntrinsicI(const GA_IntrinsicEval &, \
86  int64 *, GA_Size) const OVERRIDE; \
87  virtual GA_Size localGetIntrinsicF(const GA_IntrinsicEval &, \
88  fpreal64 *, GA_Size) const OVERRIDE; \
89  virtual GA_Size localGetIntrinsicS(const GA_IntrinsicEval &, \
90  UT_String &) const OVERRIDE; \
91  virtual GA_Size localGetIntrinsicSA(const GA_IntrinsicEval &, \
92  UT_StringArray &) const OVERRIDE; \
93  virtual GA_Size localGetIntrinsicD(const GA_IntrinsicEval &, \
94  UT_OptionsHolder &) const OVERRIDE; \
95  virtual GA_Size localGetIntrinsicDA(const GA_IntrinsicEval &, \
96  UT_Array<UT_OptionsHolder> &) const OVERRIDE; \
97  virtual GA_Size localSetIntrinsicI(const GA_IntrinsicEval &, \
98  const int64 *, GA_Size) OVERRIDE; \
99  virtual GA_Size localSetIntrinsicF(const GA_IntrinsicEval &, \
100  const fpreal64 *, GA_Size) OVERRIDE; \
101  virtual GA_Size localSetIntrinsicSS(const GA_IntrinsicEval &, \
102  const char **, GA_Size) OVERRIDE; \
103  virtual GA_Size localSetIntrinsicSA(const GA_IntrinsicEval &, \
104  const UT_StringArray &) OVERRIDE; \
105  virtual GA_Size localSetIntrinsicDS(const GA_IntrinsicEval &, \
106  const UT_OptionsHolder *, GA_Size) OVERRIDE; \
107  virtual GA_Size localSetIntrinsicDA(const GA_IntrinsicEval &, \
108  const UT_Array<UT_OptionsHolder> &) OVERRIDE;
109 
111 {
112 protected:
113  /// NOTE: The constructor should only be called from subclass
114  /// constructors.
117  : myDetail(&detail)
118  , myOffset(offset)
119  {}
120 
121 public:
122  /// NOTE: The destructor should only be called from subclass
123  /// destructors; only GA_PrimitiveList should be calling
124  /// delete on GA_Primitive pointers.
125  virtual ~GA_Primitive()
126  {
127  // The detail should have already deleted the vertices, and
128  // myVertexList is automatically cleaned up in its destructor.
129  }
130 
131  virtual const GA_PrimitiveDefinition &getTypeDef() const = 0;
132 
133  const char *getTypeName() const
134  { return getTypeDef().getToken(); }
135 
136  /// Gets the detail containing this primitive.
137  ///
138  /// FIXME: This should return a const detail, and a non-const version should
139  /// return a non-const detail.
142  { return *myDetail; }
143 
144  /// Gets the offset of this primitive in the detail containing it.
147  { return myOffset; }
148 
149  /// Gets the index of this primitive in the detail containing it.
152  { return myDetail->primitiveIndex(myOffset); }
153 
154  /// Gets the index map for primitives in the detail containing this primitive.
156  const GA_IndexMap &getIndexMap() const
157  { return myDetail->getPrimitiveMap(); }
158 
159  SYS_DEPRECATED_HDK(13.0)
160  GA_Index getNum() const
161  { return getMapIndex(); }
162 
163  /// For defragmentation, we need to update the offset
164  void swapOffsetValue(const GA_Defragment &defrag);
165 
166  /// Returns true if the primitive is part of a 3D geometry detail
167  /// (GEO_Detail), and false if it is part of a 2D geometry detail
168  /// (GD_Detail) for trim/projection curves.
169  bool isPrimary() const
170  { return myDetail->isPrimary(); }
171 
172  // FIXME: Switch this back to SYS_FORCE_INLINE when Microsoft fixes
173  // Visual Studio bug report ID 2154929.
174  // It seems to be fixed in Update 3, so I updated the define,
175  // but we haven't switched our builds over yet from Update 1.
178  { return getTypeDef().getId(); }
180  { return getTypeDef().getFamilyMask(); }
181  bool isFamily(unsigned family_mask) const
182  { return ((getFamilyMask() & family_mask) != 0); }
183 
184  /// Whether the primitive has a transform associated with it
185  bool hasLocalTransform() const
186  { return getTypeDef().hasLocalTransform(); }
187  /// Return the local transform matrix for the primitive. Some primitives
188  /// don't store transforms (see @c hasLocalTransform()). The default
189  /// behaviour is to make the transform an identity.
190  virtual void getLocalTransform(UT_Matrix3D &matrix) const;
191 
192  /// Return the local transform matrix for the primitive, but with the
193  /// translates specified by the position of the first vertex of the
194  /// primitive. This only includes the local transform and the translate
195  /// due to the point position.
196  virtual void getLocalTransform4(UT_Matrix4D &matrix) const;
197 
198  /// Set the local transform. The default implementation does nothing.
199  virtual void setLocalTransform(const UT_Matrix3D &matrix);
200 
201  /// @deprecated This method is only for transitional backward compatibility
202  /// for the HDK and will be removed in a future release.
203  /// TODO: Should be pure virtual here, overwritten at GEO_Primitive.
205  { return primCompatMaskFromTypeId(getTypeId().get()); }
206 
207  /// Report approximate memory usage, including sizeof(*this) and
208  /// any shared memory.
209  virtual int64 getMemoryUsage() const
210  {
211  return sizeof(*this) + getBaseMemoryUsage();
212  }
213 
214  /// Count memory usage using a UT_MemoryCounter in order to count
215  /// shared memory correctly.
216  /// NOTE: This should always include sizeof(*this).
217  virtual void countMemory(UT_MemoryCounter &counter) const;
218 
219  /// @{
220  /// This method is called when the vertex index map is being defragmented.
221  /// Since the defragmentation process moves vertex offsets, primitives need
222  /// to update their references with the new values. @code
223  /// new_vtx_offset = defrag.mapOffset(new_vtx_offset);
224  /// myOffsetList.swapOffsetValues(defrag);
225  /// myOffsetMatrix.swapOffsetValues(defrag);
226  /// @endcode
227  virtual void swapVertexOffsets(const GA_Defragment &defrag);
228  /// @}
229 
230  /// Return the number of vertices used by this primitive
233  {
234  return myVertexList.size();
235  }
236 
237  /// Given an vertex number (into the primitive's vertex list), return the
238  /// vertex offset.
240  GA_Offset getVertexOffset(GA_Size primvertexnum) const
241  {
242  UT_ASSERT_P(primvertexnum >= 0 && primvertexnum < myVertexList.size());
243  return myVertexList.get(primvertexnum);
244  }
246  GA_Index getVertexIndex(GA_Size primvertexnum) const
247  {
248  return getDetail().vertexIndex(getVertexOffset(primvertexnum));
249  }
250 
251  /// Given a vertex number (into the primitive's vertex list), return the
252  /// point offset.
255  { return getDetail().vertexPoint(getVertexOffset(i)); }
256 
257  /// Given a vertex number (into the primitive's vertex list), set the
258  /// corresponding point offset.
261  {
262  getDetail().setVertexPoint(getVertexOffset(i), ptoff);
263  }
264 
265  /// Given a vertex number (into the primitive's vertex list), return its
266  /// point index number.
269  { return getDetail().pointIndex(getPointOffset(i)); }
270 
271  /// Given a vertex number (into the primitive's vertex list), return its
272  /// point's position.
275  { return getDetail().getPos3(getPointOffset(i)); }
278  { return getDetail().getPos3D(getPointOffset(i)); }
279  template <typename T>
281  { return getDetail().getPos3T<T>(getPointOffset(i)); }
282 
283  /// Given a vertex number (into the primitive's vertex list),
284  /// move the point to the specified position.
286  void setPos3(GA_Size i, const UT_Vector3 &pos) const
287  { getDetail().setPos3(getPointOffset(i), pos); }
289  void setPos3(GA_Size i, const UT_Vector3D &pos) const
290  { getDetail().setPos3(getPointOffset(i), pos); }
291 
292  /// Given a vertex number (into the primitive's vertex list), return its
293  /// point's position.
296  { return getDetail().getPos4(getPointOffset(i)); }
299  { return getDetail().getPos4D(getPointOffset(i)); }
300 
301  /// Given a vertex number (into the primitive's vertex list),
302  /// move the point to the specified position.
304  void setPos4(GA_Size i, const UT_Vector4 &pos) const
305  { getDetail().setPos4(getPointOffset(i), pos); }
307  void setPos4(GA_Size i, const UT_Vector4D &pos) const
308  { getDetail().setPos4(getPointOffset(i), pos); }
309 
310  /// Get a range of all the vertices accessed by the primitive
311  GA_Range getVertexRange(bool harden=false) const
312  {
313  return GA_Range(getDetail(), getMapOffset(),
315  harden);
316  }
317  /// Get a range of all the points accessed by the primitive. Note, the
318  /// range may visit points multiple times.
319  GA_Range getPointRange(bool harden=false) const
320  {
321  return GA_Range(getDetail(), getMapOffset(),
323  harden);
324  }
325 
326  /// Return whether a point is referenced by a primitive. This simply
327  /// iterates over the vertices, checking if any vertices reference the
328  /// point.
329  bool isPointUsed(GA_Offset ptoff) const
330  {
331  GA_Size nvtx = getVertexCount();
332  for (GA_Size i = 0; i < nvtx; ++i)
333  {
334  if (getPointOffset(i) == ptoff)
335  return true;
336  }
337  return false;
338  }
339 
340  /// Add all points referenced by the primitive to the given group. This
341  /// defaults to iterating over the vertices and adding their referenced
342  /// points.
343  void addPointRefToGroup(GA_PointGroup &grp) const;
344 
345  /// Method to determine if a primitive has an edge (undirected).
346  virtual bool hasEdge(const GA_Edge &edge) const;
347 
348 
349  /// Calls apply for each directed edge in this primitive
350  /// @deprecated Use @c iterateEdges instead.
351  SYS_DEPRECATED_HDK_REPLACE(16.0, iterateEdges)
352  void edgeApply(GA_EdgeApplyFunc apply, void *data = nullptr) const;
353 
354  /// Calls apply for each directed edge in this primitive
355  /// @deprecated Use @c iterateEdgesByVertex instead.
356  SYS_DEPRECATED_HDK_REPLACE(16.0, iterateEdgesByVertex)
357  void edgeApplyIndex(GA_EdgeApplyIndexFunc apply, void *data = nullptr) const;
358 
359  /// Calls @c apply_func for each directed edge on the primitive.
360  /// If the @c apply_func function returns @c false, then the
361  /// traversal will be stopped.
362  virtual void iterateEdges(GA_IterateEdgesFunc apply_func) const
363  {
364  // Default implementation does nothing.
365  // Re-implemented by relevant primitives.
366  }
367 
368  /// Calls @c apply_func for each directed edge on the primitive,
369  /// passing in the @c GA_Size primitive vertex index for each point on the
370  /// edge. If the @c apply_func function returns @c false, then the
371  /// traversal will be stopped.
372  virtual void iterateEdgesByVertex(GA_IterateEdgesByVertexFunc apply_func) const
373  {
374  // Default implementation does nothing.
375  // Re-implemented by relevant primitives.
376  }
377 
378  /// Calls edgeApplyIndex to find the vertices within this primitive,
379  /// corresponding with the first undirected edge between ptoff0 and ptoff1.
380  /// If the edge is not in this primitive, vtx0 and vtx1 will not be
381  /// written-to, and the function will return false.
382  /// When written, vtx0->vtx1 will always be the direction the edge
383  /// appears in this primitive, which may be *opposite* ptoff0->ptoff1.
384  bool findEdgePoints(GA_Offset ptoff0, GA_Offset ptoff1,
385  GA_Size &vtx0, GA_Size &vtx1) const;
386 
387  /// The return status of @c dereferencePoint()
388  /// - GA_DEREFERENCE_FAIL @n
389  /// The primitive cannot detach itself from the points and thus the
390  /// points cannot be deleted. It's possible that the primitive may be
391  /// destroyed in this case if the user specified this behaviour (see
392  /// GA_Detail::GA_DestroyPointMode).
393  /// - GA_DEREFERENCE_OK @n
394  /// The primitive has detached the points and is still valid.
395  /// - GA_DEREFERENCE_DEGENERATE @n
396  /// The primitive has detached the points but is now degenerate.
397  /// - GA_DEREFERENCE_DESTROY @n
398  /// The primitive has detached the points and should now be destroyed.
400  {
405  };
406  /// Before points are deleted, all primitives referencing the points will
407  /// be notified using @c dereferencePoint or @c dereferencePoints. These
408  /// methods should return the appropriate DeferefenceStatus.
409  /// @example
410  /// A quadric primitive will return
411  /// - GA_DEREFERENCE_OK @n
412  /// If it's point is not in the point group
413  /// - GA_DEREFERENCE_DESTROY @n
414  /// If it destroyed its vertex
415  /// A hull primitive will return
416  /// - GA_DEREFERENCE_OK @n
417  /// If a full row or column was dereferenced
418  /// - GA_DEREFERENCE_DEGENERATE @n
419  /// If a full row/column was dereferenced, leaving a degenerate
420  /// primitive.
421  /// - GA_DEREFERENCE_FAIL @n
422  /// If a single point from within the hull cannot be dereferenced
423  /// The @c dry_run parameter will prevent the point from actually being
424  /// detached.
425  virtual GA_DereferenceStatus dereferencePoint(GA_Offset point,
426  bool dry_run=false) = 0;
427  virtual GA_DereferenceStatus dereferencePoints(
428  const GA_RangeMemberQuery &pt_q,
429  bool dry_run=false) = 0;
430 
431  /// @{
432  /// Enlarge a bounding box by the bounding box of the primitive. A
433  /// return value of false indicates an error in the operation, most
434  /// likely an invalid P. By default, these methods simply enlarge the
435  /// bounding box based on the vertices.
436  virtual bool enlargeBoundingBox(UT_BoundingRect &b,
437  const GA_Attribute *P) const;
438  virtual bool enlargeBoundingBox(UT_BoundingBox &b,
439  const GA_Attribute *P) const;
440  /// @}
441 
442  /// Enlarge a bounding box by the visible bounding box of the primitive.
443  ///
444  /// A return value of false indicates an error in the operation, most
445  /// likely an invalid P. By default, it merely calls enlargeBoundingBox()
446  virtual bool enlargeVisibleBoundingBox(
447  UT_BoundingBox &b,
448  const GA_Attribute *P) const;
449 
450  /// Enlarge a bounding sphere to encompass the primitive. A return value
451  /// of false indicates an error in the operation, most likely an invalid
452  /// P. By default, this method simply enlarges the bounding box based on
453  /// the vertices.
454  virtual bool enlargeBoundingSphere(UT_BoundingSphere &b,
455  const GA_Attribute *P) const;
456 
457  /// Enlarge a point bounding box for implicit primitive bounds. If a
458  /// primitive (such as a sphere) has a bounding box larger than its point
459  /// hull, then it should implement this method. Otherwise, it can rely on
460  /// the default behaviour.
461  ///
462  /// NOTE: If you make a custom primitive type whose bounding box may be
463  /// larger than the bounding box of the points referenced by
464  /// vertices of the primitive, you must override this function
465  /// in order for the detail's bounding box to be correctly computed.
466  /// It does not suffice to override GEO_Primitive::getBBox(), since
467  /// GA_Detail::computeQuickBounds will find the point bounding box
468  /// of the entire detail, and then call enlargePointBounds
469  /// on all primitives except polygons, tetrahedra, polysoups,
470  /// and other primitive types that are known in advance to not
471  /// exceed their point bounding boxes.
472  virtual void enlargePointBounds(UT_BoundingBox &box) const;
473 
474  /// Is the primitive degenerate
475  virtual bool isDegenerate() const = 0;
476 
477  /// Copy the specified primitive as part of the merge. The source
478  /// primitive will be of the same type.
479  ///
480  /// Since the vertex offsets will change for the merged geometry, the map
481  /// should be used to lookup the new vertex offsets. For example
482  /// @code
483  /// map.mapDestFromSource( GA_ATTRIB_VERTEX, source_vertex );
484  /// @endcode
485  ///
486  /// @see GA_MergeMap
488  const GA_Primitive *src, const GA_MergeMap &map)
489  {
490  UT_ASSERT(src != this);
491  copyVertexListForMerge(src->myVertexList, map);
492  copySubclassData(src);
493  }
494 
495  /// Copy all subclass data from source to this.
496  ///
497  /// The vertex lists of source and this must already be equivalent
498  /// in some manner, though possibly referring to different vertices.
499  ///
500  /// If some subclass data is dependent on the vertex list contents,
501  /// (such as GEO_PrimPolySoup::myPolygonVertexList),
502  /// it should be mapped based on the correspondence between the two.
503  /// GEO_PrimPolySoup is currently the only primitive type with this
504  /// sort of dependence, so it's probably best not to add more.
505  ///
506  /// NOTE: This must be safe to call on different primitives
507  /// in parallel at the same time.
508  virtual void copySubclassData(const GA_Primitive *source)
509  {
510  UT_ASSERT_P(source != nullptr);
511  UT_ASSERT_P(source != this);
512  UT_ASSERT_P(source->getTypeId() == getTypeId());
513  UT_ASSERT_P(myVertexList.size() == source->myVertexList.size());
514  UT_ASSERT_P(myVertexList.getExtraFlag() == source->myVertexList.getExtraFlag());
515  };
516 
517  /// This method returns the JSON interface for saving/loading the primitive
518  /// If the method returns a NULL pointer, then the primitive will @b not
519  /// be saved to geometry files (and thus cannot be loaded).
520  virtual const GA_PrimitiveJSON *getJSON() const = 0;
521 
522  /// Some primitives can have common/shared data between different
523  /// instances of the primitives. This method is invoked during the save
524  /// process to save data. The method requires you to save two objects
525  /// sequentially (the data is stored in a list) for each shared key:
526  /// - The primitive typedef name. This is used at load time to find the
527  /// definition which knows how to load the data.
528  /// - The data required to represent the shared object. This is
529  /// typically a list or map containing the type of data, the key value
530  /// (used for loading) and the actual object data.
531  ///
532  /// If there are multiple shared data pointers, the array can continue with name/value pairs.
533  ///
534  /// For example, you might have something like: @code
535  /// const char *key = makeKeyForSharedPtr(ptr);
536  /// bool ok = true;
537  /// if (!save.hasSavedSharedData(key))
538  /// {
539  /// save.setSavedSharedData(key); // Flag this data as saved
540  /// ok = ok && w.jsonStringToken(getTypeName());
541  /// ok = ok && w.jsonBeginArray();
542  /// ok = ok && w.jsonStringToken("datatype");
543  /// ok = ok && w.jsonStringToken(key);
544  /// ok = ok && saveSharedData(ptr);
545  /// ok = ok && w.jsonEndArray();
546  /// }
547  /// return ok;
548  /// @endcode
549  /// Then in the primitive JSON, you'd likely want to have two fields, one
550  /// for the shared data pointer, the other for an expanded version of the
551  /// data. The @c shouldSaveField() method would be something like: @code
552  /// if (index == SHARED_DATA_KEY)
553  /// return save.hasSavedSharedData(key);
554  /// if (index == EXPANDED_DATA_KEY)
555  /// return !save.hasSavedSharedData(key);
556  /// @endcode
557  ///
558  /// Then the saveField() method of the primitive JSON would look something
559  /// like: @code
560  /// switch (index)
561  /// {
562  /// case SHARED_DATA_KEY:
563  /// UT_ASSERT(save.hasSaveSharedData(key));
564  /// return w.jsonString(key);
565  /// case EXPANDED_DATA_KEY:
566  /// UT_ASSERT(!save.hasSaveSharedData(key));
567  /// return saveSharedData(ptr);
568  /// }
569  /// @endcode
570  ///
571  /// During the loading process, you can just get the shared data from the
572  /// load map. @code
573  /// MySharedDataContainer *data;
574  /// data = load.sharedLoadDataAs<MySharedDataContainer>(key);
575  /// if (data)
576  /// setSharedPointer(data->getSharedData();
577  /// else
578  /// return false;
579  /// @endcode
580  virtual bool saveSharedLoadData(
581  UT_JSONWriter &w,
582  GA_SaveMap &save,
583  GA_GeometryIndex *geo_index) const;
584 
585  virtual bool registerSharedLoadData(
586  int load_data_type,
588 
589  virtual bool loadH9(UT_IStream &is,
590  const UT_Array<GA_AttribLoadDataH9> &prim_attribs,
591  const UT_Array<GA_AttribLoadDataH9> &vtx_attribs);
592  virtual bool saveH9(std::ostream &os, bool binary,
593  const UT_Array<GA_AttribSaveDataH9> &prim_attribs,
594  const UT_Array<GA_AttribSaveDataH9> &vtx_attribs)
595  const;
596 
597  // ------------ Intrinsic interface ------------
598  /// Get the intrinsic manager for primitive intrinsics.
599  /// All primitives have at least the following intrinsics:
600  /// - "string typename" @n The type name of the primitive
601  /// - "int typeid" @n The type id (may change per run)
602  /// - "int vertexcount" @n The number of vertices in the primitive
604  { return getTypeDef().getIntrinsicManager(); }
605 
606  /// @{
607  /// Query properties of the primitive intrinsic.
608  /// Note that the tuple size calls the virtual method since the tuple size
609  /// may be dynamic (i.e. basis knot vector)
611  { return getIntrinsicManager().getLocalHandle(nm); }
613  { return getIntrinsicManager().getLocalHandle(h); }
615  { return getIntrinsicManager().getGlobalHandle(h); }
616 
618  { return getIntrinsicManager().getName(h); }
619  GA_Size getIntrinsicTupleSize(GA_LocalIntrinsic h) const;
621  { return getIntrinsicManager().getStorage(h); }
623  { return getIntrinsicManager().getReadOnly(h); }
625  { return getIntrinsicManager().getOptions(h); }
626  /// @}
627 
628  /// @{
629  /// Get the value of a primitive intrinsic.
630  /// These methods return the number of items retrieved.
631  GA_Size getIntrinsic(GA_LocalIntrinsic h, UT_String &val) const;
632  GA_Size getIntrinsic(GA_LocalIntrinsic h, UT_StringArray &val) const;
633  GA_Size getIntrinsic(GA_LocalIntrinsic h, UT_OptionsHolder &val) const;
635  GA_Size getIntrinsic(GA_LocalIntrinsic h, int64 *v, GA_Size size) const;
636  GA_Size getIntrinsic(GA_LocalIntrinsic h, fpreal64 *v, GA_Size sz) const;
637  /// @}
638 
639  /// @{
640  /// Get the value of a primitive intrinsic.
641  /// Returns false if not the right type or not found.
642  /// Always will clear out the provided value.
643  bool getIntrinsic(GA_LocalIntrinsic h, float &v) const;
644  bool getIntrinsic(GA_LocalIntrinsic h, int &v) const;
645  bool getIntrinsic(GA_LocalIntrinsic h, UT_Vector2 &v) const;
646  bool getIntrinsic(GA_LocalIntrinsic h, UT_Vector3 &v) const;
647  bool getIntrinsic(GA_LocalIntrinsic h, UT_Vector4 &v) const;
648  bool getIntrinsic(GA_LocalIntrinsic h, UT_Matrix2 &v) const;
649  bool getIntrinsic(GA_LocalIntrinsic h, UT_Matrix3 &v) const;
650  bool getIntrinsic(GA_LocalIntrinsic h, UT_Matrix4 &v) const;
651  bool getIntrinsic(GA_LocalIntrinsic h, double &v) const;
652  bool getIntrinsic(GA_LocalIntrinsic h, int64 &v) const;
653  bool getIntrinsic(GA_LocalIntrinsic h, UT_Vector2D &v) const;
654  bool getIntrinsic(GA_LocalIntrinsic h, UT_Vector3D &v) const;
655  bool getIntrinsic(GA_LocalIntrinsic h, UT_Vector4D &v) const;
656  bool getIntrinsic(GA_LocalIntrinsic h, UT_Matrix2D &v) const;
657  bool getIntrinsic(GA_LocalIntrinsic h, UT_Matrix3D &v) const;
658  bool getIntrinsic(GA_LocalIntrinsic h, UT_Matrix4D &v) const;
659 
660  /// @}
661 
662  /// @{
663  /// Set intrinsic attributes. This will fail if the intrinsic is read-only.
664  /// These methods return the number of items set.
665  GA_Size setIntrinsic(GA_LocalIntrinsic h, const char *value);
666  GA_Size setIntrinsic(GA_LocalIntrinsic h, const UT_StringArray &value);
667  GA_Size setIntrinsic(GA_LocalIntrinsic h, const char **val, GA_Size s);
668  GA_Size setIntrinsic(GA_LocalIntrinsic h, const UT_OptionsHolder &value);
670  GA_Size setIntrinsic(GA_LocalIntrinsic h, const UT_OptionsHolder *value, GA_Size s);
671  GA_Size setIntrinsic(GA_LocalIntrinsic h, const int64 val);
672  GA_Size setIntrinsic(GA_LocalIntrinsic h, const fpreal64 val);
673  GA_Size setIntrinsic(GA_LocalIntrinsic h, const int64 *val, GA_Size sz);
674  GA_Size setIntrinsic(GA_LocalIntrinsic h, const fpreal64 *v, GA_Size sz);
675  /// @}
676 
677  /// Private interface
678  /// The clearForDeletion() method is called just prior to the detail being
679  /// cleared out. This allows the primitive to simplify its data structures,
680  /// knowing that topology doesn't need to be maintained (i.e. unwiring all
681  /// vertices);
682  virtual void clearForDeletion() {}
683 
684  /// Return the next and previous vertex on the "boundary" of the primitive
685  /// (as understood by the primitive) relative to a given vertex. These are
686  /// needed to maintain half-edge topology attributes.
687  /// They must be implemented for primitives that realize a notion of a
688  /// boundary composed of one or more closed cycles of vertices if we want
689  /// to be able to use hedges to quickly move from such a primitive to
690  /// another sharing an edge with it. A GA_INVALID_OFFSET for prev_vtx or
691  /// next_vtx means that either the primitive doesn't care about hedges,
692  /// the input vertex is not a boundary vertex in the primitive (or not a
693  /// vertex at all), or vtx is at an end of a boundary (e.g. open polys).
695  GA_Offset &prev_vtx,
696  GA_Offset &next_vtx) const
697  { prev_vtx = next_vtx = GA_INVALID_OFFSET; }
698 
699  /// Primitives that implement getAdjacentBoundaryVertices must respond true
700  /// to supportsHedge().
701  virtual bool supportsHedge() const
702  { return false; }
703 
704  /// Release the given vertex. This is equivalent to deleting a vertex
705  /// without modifying its topology attributes. In other words, the primitive
706  /// doesn't use the vertex anymore, but the vertex stays wired to the
707  /// primitive and to the point it was wired to. The intended use is with
708  /// stealVertex methods, so that the same vertex can be aquired by another
709  /// primitive, thus maintaining its offset number and attributes The return
710  /// value is the vertex offset (same as input) if successful and
711  /// GA_INVALID_OFFSET otherwise.
713  { return GA_INVALID_OFFSET; }
714 
715 
716  /// Backward compatible methods for GD library
717  /// Determine whether the primitive is visisble on the interval of the
718  /// parent surface. Partial visiblity should return true as well.
719  /// @return
720  /// - @c 0: Not visible on parent surface
721  /// - @c 1: Full visibility (@b default)
722  /// - @c 2: Partial visibility
723  virtual int isVisible() const;
724 
725  /// A primitive may support any number of secondary details.
726  virtual unsigned getNumSecondaryDetails() const;
727  virtual const GA_Detail *getSecondaryDetail(GA_Index i) const;
728  virtual GA_Detail *getSecondaryDetail(GA_Index i);
729 
730  GA_Index getNumSecondary(GA_Index detail) const;
731  const GA_Primitive *getSecondaryByIndex(GA_Index detail, GA_Index i) const;
732  GA_Primitive *getSecondaryByIndex(GA_Index detail, GA_Index i);
733  const GA_Primitive *getSecondaryByOffset(GA_Index detail,
734  GA_Offset o) const;
735  GA_Primitive *getSecondaryByOffset(GA_Index detail, GA_Offset o);
736 
737  /// @{
738  /// Primitives must provide these methods
739  virtual void reverse() = 0;
740  /// @}
741 
742  /// @{
743  /// Measure the primitive.
744  virtual fpreal calcVolume(const UT_Vector3 &refpt) const
745  { return 0; }
746  virtual fpreal calcArea() const { return 0; }
747  virtual fpreal calcPerimeter() const { return 0; }
748  /// @}
749 
750  /// A trivial vertex list is a uniform ascending list, so
751  /// getFastVertexOffset(i) == getFastVertexOffset(0) + i
753  bool isVertexListTrivial() const { return myVertexList.isTrivial(); }
754  /// A trivial point list is doubly-trivial:
755  /// getPointOffset(i) == getPointOffset(0) + i
756  /// This requires testing every point so is slower than isVertexListTrivial.
757  bool isPointListTrivial() const;
758 
759  /// Calls a functor (e.g. a lambda) for each vertex offset in this
760  /// primitive, in the order they occur in the vertex list.
761  /// This is optimized to only check triviality once.
762  template<typename FUNCTOR>
764  void forEachVertex(FUNCTOR &&functor) const
765  {
766  myVertexList.forEach(functor);
767  }
768 
769  /// Calls a functor (e.g. a lambda) for each point offset in this
770  /// primitive, in the order they occur in the vertex list.
771  /// This is optimized to only check triviality once and only look up
772  /// the vertex-to-point topology attribute once.
773  template<typename FUNCTOR>
775  void forEachPoint(FUNCTOR &&functor) const
776  {
777  const GA_ATITopology *vtx_to_pt = myDetail->getTopology().getPointRef();
778  myVertexList.forEach([vtx_to_pt,&functor](GA_Offset vtx){
779  functor(vtx_to_pt->getLink(vtx));
780  });
781  }
782 
783  bool vertexApply(bool(*apply)(GA_Offset vtx, void *),
784  void *data = nullptr) const
785  {
786  for (GA_Size i = 0, n = getVertexCount(); i < n; ++i)
787  {
788  if (apply(getVertexOffset(i), data))
789  return true;
790  }
791  return false;
792  }
793 
794  /// Stash (deactivate) or unstash (reactivate) the primitive.
795  ///
796  /// Stashing a primitive will set its offset to that specified, typically
797  /// GA_INVALID_OFFSET. Primitives are only stashed as part of clearing a
798  /// detail, so there is no need to explicitly deallocate vertices. It is
799  /// safe to delete a stashed primitive.
800  ///
801  /// Unstashing a primitive will re-register that primitive with its parent
802  /// detail at the specified offset (or a new offset if GA_INVALID_OFFSET).
803  virtual void stashed(bool beingstashed,
805 
806  /// Copy any modified caches from the GPU back to CPU cache.
807  virtual void flushCEWriteCaches() {}
808 
809  /// Copy any modified caches from the GPU to CPU. Then delete the GPU
810  /// cache.
811  virtual void flushCECaches() {}
812 
813  /// Steal the underlying CE buffer from the source.
814  virtual void stealCEBuffers(const GA_Primitive *src) {}
815 
816  static SYS_FORCE_INLINE
819  {
821  if (type_id < GA_PrimCompat::TypeMaskBits)
822  m = (GA_PrimCompat::value_type)1 << type_id;
823  return GA_PrimCompat::TypeMask(m);
824  }
825 
826 protected:
827  void setNumVertices(GA_Size nvertices);
828 
829  /// allocateVertex() will call wireVertex() if the point given is not -1
830  GA_Offset allocateVertex(GA_Offset point=GA_INVALID_OFFSET);
831  void destroyVertex(GA_Offset vertex);
832  void wireVertex(GA_Offset vertex, GA_Offset point);
833 
834  /// Create the topological binding between preallocated vertex and
835  /// primitive.
836  void registerVertex(GA_Offset vertex);
837 
838  /// Report approximate memory usage for myVertexList for subclasses.
841  {
842  return myVertexList.getMemoryUsage(false);
843  }
844 
845  /// This is called by the subclasses to count the
846  /// memory used by myVertexList
847  void countBaseMemory(UT_MemoryCounter &counter) const;
848 
849  /// This is the implementation of this level of copyUnwiredForMerge,
850  /// and enables GA_PrimitiveList to set the vertex list without a
851  /// source primitive.
852  void copyVertexListForMerge(
853  const GA_OffsetListRef &src_vertices, const GA_MergeMap &map);
854 
855  /// @{
856  /// Implementation of intrinsic attributes. See GA_IntrinsicEval
857  /// for further details. See GA_IntrinsicMacros.h for implementation of
858  /// intrinsics.
859  /// @note When implementing support for string intrinsic attributes, please
860  /// ensure to implement for @b all methods (localGetIntrinsicS,
861  /// localGetIntrinsicSA for reading and localSetIntrinsicSA,
862  /// localSetIntrinsicSS for writing). You should do this even if the
863  /// string tuple size is 1.
865  /// @}
866 
867 private:
868 
870  void unstashImpl(GA_Offset offset)
871  {
872  UT_ASSERT_P(myVertexList.size() == 0);
873  myOffset = offset;
874  }
875 
876  friend class GA_PrimitiveList;
877 
878  GA_Detail *myDetail;
879  GA_Offset myOffset;
880 protected:
882 };
883 
887 {
888  return myPrimitiveList.getVertexList(primoff);
889 }
890 
892 GA_Size
894 {
895  return myPrimitiveList.getVertexCount(primoff);
896 }
897 
899 GA_Offset
901 {
902  return myPrimitiveList.getVertexOffset(primoff, i);
903 }
904 
906 int
908 {
909  return myPrimitiveList.getTypeId(primoff);
910 }
911 
913 bool
915 {
916  return myPrimitiveList.getClosedFlag(primoff);
917 }
918 
920 void
922 {
923  myPrimitiveList.setClosedFlag(primoff, closed);
924 }
925 
929 {
930  UT_ASSERT_P(!myDetail.getPrimitiveMap().isOffsetVacant(primoff));
931  const GA_Primitive *const*prim_array = myList;
932  if (!prim_array)
933  {
934  GA_PageNum pagenum = GAgetPageNum(primoff);
935  GA_PageOff pageoff = GAgetPageOff(primoff);
936  auto p = myVertexLists.getPageData(pagenum);
937  UT_ASSERT_COMPILETIME(2*sizeof(*p) == sizeof(GA_OffsetListRef));
938  auto po = reinterpret_cast<const GA_OffsetListRef*>(p);
939  if (myVertexLists.isPageConstant(pagenum))
940  {
941  exint size = po->size();
942  return GA_OffsetListRef(po->trivialStart() + size*pageoff, size, po->getExtraFlag());
943  }
944  else
945  {
946  return po[pageoff];
947  }
948  }
949  else
950  {
951  UT_ASSERT_P(GAisValid(primoff) && primoff < GA_Offset(getMyListSize()));
952  return GA_OffsetListRef(prim_array[primoff]->myVertexList);
953  }
954 }
955 
957 void
959 {
960  UT_ASSERT_P(!myDetail.getPrimitiveMap().isOffsetVacant(primoff));
961  GA_Primitive *const*prim_array = myList;
962  if (!prim_array)
963  {
964  UT_ASSERT_P(GAisValid(primoff) && primoff < myVertexLists.size());
965  GA_PageNum pagenum = GAgetPageNum(primoff);
966  GA_PageOff pageoff = GAgetPageOff(primoff);
967  auto po = hardenVertexListPage(pagenum);
968  // NOTE: This does increment the ref count on any non-trivial list,
969  // so it's not a problem if vertices is really a
970  // GA_OffsetList somewhere up the call stack.
971  po[pageoff] = vertices;
972  }
973  else
974  {
975  UT_ASSERT_P(GAisValid(primoff) && primoff < GA_Offset(getMyListSize()));
976  prim_array[primoff]->myVertexList = vertices;
977  }
978 }
979 
981 void
983 {
984  UT_ASSERT_P(!myDetail.getPrimitiveMap().isOffsetVacant(primoff));
985  GA_Primitive *const*prim_array = myList;
986  if (!prim_array)
987  {
988  UT_ASSERT_P(GAisValid(primoff) && primoff < myVertexLists.size());
989  GA_PageNum pagenum = GAgetPageNum(primoff);
990  GA_PageOff pageoff = GAgetPageOff(primoff);
991  auto po = hardenVertexListPage(pagenum);
992  po[pageoff] = vertices;
993  }
994  else
995  {
996  UT_ASSERT_P(GAisValid(primoff) && primoff < GA_Offset(getMyListSize()));
997  prim_array[primoff]->myVertexList = vertices;
998  }
999 }
1000 
1002 void
1004 {
1005  UT_ASSERT_P(!myDetail.getPrimitiveMap().isOffsetVacant(primoff));
1006  GA_Primitive *const*prim_array = myList;
1007  if (!prim_array)
1008  {
1009  UT_ASSERT_P(GAisValid(primoff) && primoff < myVertexLists.size());
1010  GA_PageNum pagenum = GAgetPageNum(primoff);
1011  GA_PageOff pageoff = GAgetPageOff(primoff);
1012  auto po = hardenVertexListPage(pagenum);
1013  po[pageoff] = std::move(vertices);
1014  }
1015  else
1016  {
1017  UT_ASSERT_P(GAisValid(primoff) && primoff < GA_Offset(getMyListSize()));
1018  prim_array[primoff]->myVertexList = std::move(vertices);
1019  }
1020 }
1021 
1023 GA_Size
1025 {
1026  UT_ASSERT_P(!myDetail.getPrimitiveMap().isOffsetVacant(primoff));
1027  const GA_Primitive *const*prim_array = myList;
1028  if (!prim_array)
1029  {
1030  GA_PageNum pagenum = GAgetPageNum(primoff);
1031  UT_ASSERT_COMPILETIME(2*sizeof(int64) == sizeof(GA_OffsetList));
1032  auto p = reinterpret_cast<const GA_OffsetList*>(myVertexLists.getPageData(pagenum));
1033  if (!myVertexLists.isPageConstant(pagenum))
1034  {
1035  p += GAgetPageOff(primoff);
1036  }
1037  return p->size();
1038  }
1039  else
1040  {
1041  UT_ASSERT_P(GAisValid(primoff) && primoff < GA_Offset(getMyListSize()));
1042  return prim_array[primoff]->getVertexCount();
1043  }
1044 }
1045 
1047 GA_Offset
1049 {
1050  UT_ASSERT_P(!myDetail.getPrimitiveMap().isOffsetVacant(primoff));
1051  const GA_Primitive *const*prim_array = myList;
1052  if (!prim_array)
1053  {
1054  GA_PageNum pagenum = GAgetPageNum(primoff);
1055  GA_PageOff pageoff = GAgetPageOff(primoff);
1056  UT_ASSERT_COMPILETIME(2*sizeof(int64) == sizeof(GA_OffsetList));
1057  auto p = reinterpret_cast<const GA_OffsetList*>(myVertexLists.getPageData(pagenum));
1058  if (!myVertexLists.isPageConstant(pagenum))
1059  {
1060  return p[pageoff].get(i);
1061  }
1062  return p->trivialStart() + p->size()*pageoff + i;
1063  }
1064  else
1065  {
1066  UT_ASSERT_P(GAisValid(primoff) && primoff < GA_Offset(getMyListSize()));
1067  return prim_array[primoff]->getVertexOffset(i);
1068  }
1069 }
1070 
1072 int
1074 {
1075  UT_ASSERT_P(!myDetail.getPrimitiveMap().isOffsetVacant(primoff));
1076  const GA_Primitive *const*prim_array = myList;
1077  if (!prim_array)
1078  {
1079  return myPrimitiveTypes.get(primoff);
1080  }
1081  else
1082  {
1083  UT_ASSERT_P(GAisValid(primoff) && primoff < GA_Offset(getMyListSize()));
1084  return prim_array[primoff]->getTypeId().get();
1085  }
1086 }
1087 
1089 bool
1091 {
1092  UT_ASSERT_P(!myDetail.getPrimitiveMap().isOffsetVacant(primoff));
1093  const GA_Primitive *const*prim_array = myList;
1094  if (!prim_array)
1095  {
1096  GA_PageNum pagenum = GAgetPageNum(primoff);
1097  auto p = myVertexLists.getPageData(pagenum);
1098  if (!myVertexLists.isPageConstant(pagenum))
1099  {
1100  p += 2*GAgetPageOff(primoff);
1101  }
1102  UT_ASSERT_COMPILETIME(2*sizeof(*p) == sizeof(GA_OffsetList));
1103  return reinterpret_cast<const GA_OffsetList*>(p)->getExtraFlag();
1104  }
1105  else
1106  {
1107  UT_ASSERT_P(GAisValid(primoff) && primoff < GA_Offset(getMyListSize()));
1108  return prim_array[primoff]->myVertexList.getExtraFlag();
1109  }
1110 }
1111 
1113 void
1115 {
1116  UT_ASSERT_P(!myDetail.getPrimitiveMap().isOffsetVacant(primoff));
1117  GA_Primitive *const*prim_array = myList;
1118  if (!prim_array)
1119  {
1120  GA_PageNum pagenum = GAgetPageNum(primoff);
1121  auto p = hardenVertexListPage(pagenum);
1122  GA_PageOff pageoff = GAgetPageOff(primoff);
1123  return p[pageoff].setExtraFlag(closed);
1124  }
1125  else
1126  {
1127  UT_ASSERT_P(GAisValid(primoff) && primoff < GA_Offset(getMyListSize()));
1128  return prim_array[primoff]->myVertexList.setExtraFlag(closed);
1129  }
1130 }
1131 
1132 #endif
SIM_API const UT_StringHolder vertex
virtual void flushCEWriteCaches()
Copy any modified caches from the GPU back to CPU cache.
Definition: GA_Primitive.h:807
A class to manage an ordered array which has fixed offset handles.
Definition: GA_IndexMap.h:63
virtual void flushCECaches()
Definition: GA_Primitive.h:811
SYS_FORCE_INLINE const GA_IndexMap & getIndexMap() const
Gets the index map for primitives in the detail containing this primitive.
Definition: GA_Primitive.h:156
SYS_FORCE_INLINE bool isPageConstant(UT_PageNum pagenum) const
Returns true iff the specified page is constant-compressed.
Definition of a geometry attribute.
Definition: GA_Attribute.h:198
SYS_FORCE_INLINE GA_Offset getPrimitiveVertexOffset(GA_Offset primoff, GA_Size i) const
Definition: GA_Primitive.h:900
UT_ASSERT_COMPILETIME(BRAY_EVENT_MAXFLAGS<=32)
SYS_FORCE_INLINE GA_Offset getPointOffset(GA_Size i) const
Definition: GA_Primitive.h:254
SYS_FORCE_INLINE void setClosedFlag(GA_Offset primoff, bool closed)
SYS_FORCE_INLINE GA_Detail & getDetail() const
Definition: GA_Primitive.h:141
virtual void clearForDeletion()
Definition: GA_Primitive.h:682
SYS_FORCE_INLINE void setPos3(GA_Size i, const UT_Vector3D &pos) const
Definition: GA_Primitive.h:289
Used to pass options and map offset values during saving.
Definition: GA_SaveMap.h:48
GA_OffsetList * hardenVertexListPage(GA_PageNum pagenum)
const GA_IndexMap & getPrimitiveMap() const
Definition: GA_Detail.h:743
SYS_FORCE_INLINE GA_Size getVertexCount() const
Return the number of vertices used by this primitive.
Definition: GA_Primitive.h:232
GA_Size GA_PageOff
Definition: GA_Types.h:645
GA_LocalIntrinsic findIntrinsic(const UT_StringRef &nm) const
Definition: GA_Primitive.h:610
virtual fpreal calcPerimeter() const
Definition: GA_Primitive.h:747
SYS_FORCE_INLINE GA_Offset getLink(GA_Offset ai) const
SYS_FORCE_INLINE int getPrimitiveTypeId(GA_Offset primoff) const
Definition: GA_Primitive.h:907
void copyUnwiredForMerge(const GA_Primitive *src, const GA_MergeMap &map)
Definition: GA_Primitive.h:487
SYS_FORCE_INLINE GA_Index getVertexIndex(GA_Size primvertexnum) const
Definition: GA_Primitive.h:246
void
Definition: png.h:1083
bool hasLocalTransform() const
Whether the primitive has a transform associated with it.
Definition: GA_Primitive.h:185
GA_StorageClass
Definition: GA_Types.h:72
GLboolean * data
Definition: glcorearb.h:131
bool getIntrinsicReadOnly(GA_LocalIntrinsic h) const
Definition: GA_Primitive.h:622
const GLdouble * v
Definition: glcorearb.h:837
GA_LocalIntrinsic findIntrinsic(GA_GlobalIntrinsic h) const
Definition: GA_Primitive.h:612
virtual void copySubclassData(const GA_Primitive *source)
Definition: GA_Primitive.h:508
bool GAisValid(GA_Size v)
Definition: GA_Types.h:649
#define SYS_DEPRECATED_HDK_REPLACE(__V__, __R__)
const GLuint GLenum const void * binary
Definition: glcorearb.h:1924
SYS_FORCE_INLINE IDX_T size() const
Definition: UT_PageArray.h:899
bool isOffsetVacant(GA_Offset offset) const
SYS_FORCE_INLINE bool getExtraFlag() const
Synonym for isClosed()
GA_PrimitiveFamilyMask getFamilyMask() const
Definition: GA_Primitive.h:179
virtual ~GA_Primitive()
Definition: GA_Primitive.h:125
The merge map keeps track of information when merging details.
Definition: GA_MergeMap.h:53
SYS_FORCE_INLINE void setPointOffset(GA_Size i, GA_Offset ptoff)
Definition: GA_Primitive.h:260
int64 exint
Definition: SYS_Types.h:125
SYS_FORCE_INLINE DEST_DATA_T get(IDX_T i, exint component=0) const
Definition: UT_PageArray.h:488
void reverse(I begin, I end)
Definition: pugixml.cpp:7190
GLdouble s
Definition: glad.h:3009
SYS_FORCE_INLINE const GA_PrimitiveTypeId & getTypeId() const
Definition: GA_Primitive.h:177
Class used to map H9 geometry files to a form used by GA.
Definition: GA_AIFFileH9.h:318
#define GA_DECLARE_INTRINSICS(OVERRIDE)
Definition: GA_Primitive.h:80
Manager to keep track of global handle to name mappings.
#define GA_API
Definition: GA_API.h:14
Class which writes ASCII or binary JSON streams.
Definition: UT_JSONWriter.h:37
Abstract base class for a range membership query object.
#define GA_NO_OVERRIDE
Definition: GA_Primitive.h:76
GLfloat GLfloat GLfloat v2
Definition: glcorearb.h:818
UT_Function< bool(const GA_Edge &edge)> GA_IterateEdgesFunc
Definition: GA_Primitive.h:73
GA_ListTypeRef< GA_Size, GA_Offset > GA_OffsetListRef
virtual int64 getMemoryUsage() const
Definition: GA_Primitive.h:209
UT_SharedPtr< GA_SharedDataHandle > GA_SharedDataHandlePtr
uint64 value_type
Definition: GA_PrimCompat.h:29
exint GA_Size
Defines the bit width for index and offset types in GA.
Definition: GA_Types.h:235
SYS_FORCE_INLINE int64 getBaseMemoryUsage() const
Report approximate memory usage for myVertexList for subclasses.
Definition: GA_Primitive.h:840
GA_PageOff GAgetPageOff(GA_Offset v)
Definition: GA_Types.h:660
bool isFamily(unsigned family_mask) const
Definition: GA_Primitive.h:181
GA_PrimitiveFamilyMask
SYS_FORCE_INLINE bool getPrimitiveClosedFlag(GA_Offset primoff) const
Definition: GA_Primitive.h:914
SYS_FORCE_INLINE UT_Vector4D getPos4D(GA_Size i) const
Definition: GA_Primitive.h:298
#define GA_INVALID_OFFSET
Definition: GA_Types.h:678
GA_OffsetList myVertexList
Definition: GA_Primitive.h:881
A range of elements in an index-map.
Definition: GA_Range.h:42
int GA_GlobalIntrinsic
Definition: GA_Types.h:695
SYS_FORCE_INLINE GA_Size getVertexCount(GA_Offset primoff) const
double fpreal64
Definition: SYS_Types.h:201
SYS_FORCE_INLINE UT_Vector3D getPos3D(GA_Size i) const
Definition: GA_Primitive.h:277
GA_Size GA_Offset
Definition: GA_Types.h:641
int GA_LocalIntrinsic
Definition: GA_Types.h:694
const GA_IntrinsicManager & getIntrinsicManager() const
Definition: GA_Primitive.h:603
SYS_FORCE_INLINE UT_Vector3 getPos3(GA_Size i) const
Definition: GA_Primitive.h:274
GLdouble n
Definition: glcorearb.h:2008
GLintptr offset
Definition: glcorearb.h:665
Class used to keep track of inheritance of intrinsic attribute evaluation.
SYS_FORCE_INLINE GA_OffsetListRef getVertexList(GA_Offset primoff) const
Definition: GA_Primitive.h:928
virtual GA_PrimCompat::TypeMask getPrimitiveId() const
Definition: GA_Primitive.h:204
#define UT_ASSERT_P(ZZ)
Definition: UT_Assert.h:155
GA_Range getPointRange(bool harden=false) const
Definition: GA_Primitive.h:319
SYS_FORCE_INLINE GA_OffsetListRef getPrimitiveVertexList(GA_Offset primoff) const
Definition: GA_Primitive.h:886
#define SYS_FORCE_INLINE
Definition: SYS_Inline.h:45
GLsizei GLsizei GLchar * source
Definition: glcorearb.h:803
GA_GlobalIntrinsic findGlobalIntrinsic(GA_LocalIntrinsic h) const
Definition: GA_Primitive.h:614
UT_Function< bool(GA_Size, GA_Size)> GA_IterateEdgesByVertexFunc
Definition: GA_Primitive.h:74
Provide a JSON interface to a primitive.
SYS_FORCE_INLINE void forEachPoint(FUNCTOR &&functor) const
Definition: GA_Primitive.h:775
virtual fpreal calcArea() const
Definition: GA_Primitive.h:746
SYS_FORCE_INLINE bool isVertexListTrivial() const
Definition: GA_Primitive.h:753
SYS_FORCE_INLINE UT_Vector4 getPos4(GA_Size i) const
Definition: GA_Primitive.h:295
long long int64
Definition: SYS_Types.h:116
virtual bool supportsHedge() const
Definition: GA_Primitive.h:701
Defragmentation of IndexMaps.
Definition: GA_Defragment.h:45
#define SYS_DEPRECATED_HDK(__V__)
std::function< T > UT_Function
Definition: UT_Function.h:37
GLboolean GLboolean GLboolean b
Definition: glcorearb.h:1222
GA_Size GA_Index
Define the strictness of GA_Offset/GA_Index.
Definition: GA_Types.h:635
const NotVoidType * getPageData(UT_PageNum pagenum) const
SYS_FORCE_INLINE GA_Index getPointIndex(GA_Size i) const
Definition: GA_Primitive.h:268
SYS_FORCE_INLINE void setPos3(GA_Size i, const UT_Vector3 &pos) const
Definition: GA_Primitive.h:286
const char * getIntrinsicName(GA_LocalIntrinsic h) const
Definition: GA_Primitive.h:617
SYS_FORCE_INLINE bool getClosedFlag(GA_Offset primoff) const
A list of primitives.
bool vertexApply(bool(*apply)(GA_Offset vtx, void *), void *data=nullptr) const
Definition: GA_Primitive.h:783
SYS_FORCE_INLINE void setPos4(GA_Size i, const UT_Vector4 &pos) const
Definition: GA_Primitive.h:304
GLsizeiptr size
Definition: glcorearb.h:664
GLfloat GLfloat GLfloat GLfloat h
Definition: glcorearb.h:2002
bool isPointUsed(GA_Offset ptoff) const
Definition: GA_Primitive.h:329
A map of string to various well defined value types.
Definition: UT_Options.h:84
SYS_FORCE_INLINE GA_Index getMapIndex() const
Gets the index of this primitive in the detail containing it.
Definition: GA_Primitive.h:151
const UT_Options * getIntrinsicOptions(GA_LocalIntrinsic h) const
Definition: GA_Primitive.h:624
virtual fpreal calcVolume(const UT_Vector3 &refpt) const
Definition: GA_Primitive.h:744
GA_StorageClass getIntrinsicStorage(GA_LocalIntrinsic h) const
Definition: GA_Primitive.h:620
virtual void getAdjacentBoundaryVertices(GA_Offset vtx, GA_Offset &prev_vtx, GA_Offset &next_vtx) const
Definition: GA_Primitive.h:694
fpreal64 fpreal
Definition: SYS_Types.h:277
UT_Vector3T< T > getPos3T(GA_Size i) const
Definition: GA_Primitive.h:280
SYS_FORCE_INLINE void setPos4(GA_Size i, const UT_Vector4D &pos) const
Definition: GA_Primitive.h:307
SYS_FORCE_INLINE void forEachVertex(FUNCTOR &&functor) const
Definition: GA_Primitive.h:764
GA_Size GA_PageNum
Definition: GA_Types.h:644
SYS_FORCE_INLINE GA_Offset getMapOffset() const
Gets the offset of this primitive in the detail containing it.
Definition: GA_Primitive.h:146
Class used to map the GA attribute into a form for H9 geometry files.
Definition: GA_AIFFileH9.h:262
GLfloat GLfloat v1
Definition: glcorearb.h:817
GLuint GLfloat * val
Definition: glcorearb.h:1608
void(* GA_EdgeApplyFunc)(const GA_Primitive &prim, GA_Offset pt_a, GA_Offset pt_b, void *data)
Definition: GA_Primitive.h:68
SYS_FORCE_INLINE GA_Offset getVertexOffset(GA_Size primvertexnum) const
Definition: GA_Primitive.h:240
virtual void stealCEBuffers(const GA_Primitive *src)
Steal the underlying CE buffer from the source.
Definition: GA_Primitive.h:814
SYS_FORCE_INLINE void setPrimitiveClosedFlag(GA_Offset primoff, bool closed)
Definition: GA_Primitive.h:921
SYS_FORCE_INLINE ToType get(FromType index) const
Get the the value at the index.
Container class for all geometry.
Definition: GA_Detail.h:96
GLubyte GLubyte GLubyte GLubyte w
Definition: glcorearb.h:857
#define UT_ASSERT(ZZ)
Definition: UT_Assert.h:156
Definition: core.h:1131
SYS_FORCE_INLINE GA_Size getPrimitiveVertexCount(GA_Offset primoff) const
Definition: GA_Primitive.h:893
Definition of a geometric primitive.
#define const
Definition: zconf.h:214
bool isPrimary() const
Definition: GA_Primitive.h:169
const char * getTypeName() const
Definition: GA_Primitive.h:133
GA_Range getVertexRange(bool harden=false) const
Get a range of all the vertices accessed by the primitive.
Definition: GA_Primitive.h:311
SYS_FORCE_INLINE void setVertexList(GA_Offset primoff, const GA_OffsetListRef &vertices)
Definition: GA_Primitive.h:958
SYS_FORCE_INLINE GA_Primitive(GA_Detail &detail, GA_Offset offset=GA_INVALID_OFFSET)
Definition: GA_Primitive.h:116
void(* GA_EdgeApplyIndexFunc)(const GA_Primitive &prim, GA_Size v1, GA_Size v2, void *data)
Definition: GA_Primitive.h:70
virtual GA_Offset releaseVertex(GA_Offset vtx)
Definition: GA_Primitive.h:712
virtual void iterateEdgesByVertex(GA_IterateEdgesByVertexFunc apply_func) const
Definition: GA_Primitive.h:372
SYS_FORCE_INLINE int getTypeId(GA_Offset primoff) const
Definition: format.h:895
GA_PageNum GAgetPageNum(GA_Offset v)
Definition: GA_Types.h:656
SYS_FORCE_INLINE FromType size() const
Returns the number of used elements in the list (always <= capacity())
static SYS_FORCE_INLINE GA_PrimCompat::TypeMask primCompatMaskFromTypeId(int type_id)
Definition: GA_Primitive.h:818
GLenum src
Definition: glcorearb.h:1793
SYS_FORCE_INLINE GA_Offset getVertexOffset(GA_Offset primoff, GA_Size i) const