HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GT_PrimInstance Class Reference

#include <GT_PrimInstance.h>

+ Inheritance diagram for GT_PrimInstance:

Public Member Functions

 GT_PrimInstance ()
 
 GT_PrimInstance (const GT_PrimitiveHandle &geometry, const GT_TransformArrayHandle &transforms, const GT_GEOOffsetList &packed_prim_offsets=GT_GEOOffsetList(), const GT_AttributeListHandle &uniform=GT_AttributeListHandle(), const GT_AttributeListHandle &detail=GT_AttributeListHandle(), const GT_GEODetailListHandle &source=GT_GEODetailListHandle())
 
 GT_PrimInstance (const GT_PrimInstance &src)
 
virtual ~GT_PrimInstance ()
 
bool isValid () const
 Check valid. More...
 
GT_Size entries () const
 Return number of instances. More...
 
const GT_PrimitiveHandlegeometry () const
 Return geometry to be instanced. More...
 
const GT_TransformArrayHandletransforms () const
 Return transforms for instances. More...
 
GT_TransformArrayHandletransforms ()
 Non-const transform access (for appending new transforms). More...
 
const GT_AttributeListHandleuniform () const
 Return uniform attributes. More...
 
const GT_AttributeListHandledetail () const
 Return detail attributes. More...
 
const GT_GEOOffsetListpackedPrimOffsets () const
 
GT_TransformArrayHandle combinedTransforms () const
 
bool refineToInstances (GT_Refine &refiner, const GT_RefineParms *parms) const
 
bool flattenInstances (GT_Refine &refiner, const GT_RefineParms *parms) const
 
GT_PrimitiveHandle expandInstanceTransforms () const
 
virtual bool isSimplePrimitive (int primitive_type) const
 
virtual bool updateGeoPrim (const GU_ConstDetailHandle &dtl, const GT_RefineParms &refine)
 update any cached data for geometry and its attributes More...
 
virtual const char * className () const
 
virtual int getPrimitiveType () const
 
virtual void enlargeBounds (UT_BoundingBox boxes[], int nsegs) const
 
virtual void enlargeRenderBounds (UT_BoundingBox boxes[], int nsegs) const
 
virtual void getVelocityRange (UT_Vector3 &vmin, UT_Vector3 &vmax, const char *attribute_name) const
 
virtual bool refine (GT_Refine &refiner, const GT_RefineParms *parms=NULL) const
 
virtual int getMotionSegments () const
 
virtual int64 getMemoryUsage () const
 
virtual bool save (UT_JSONWriter &w) const
 
virtual fpreal computePerimeter (int seg=0) const
 
virtual fpreal computeSurfaceArea (int seg=0) const
 
virtual fpreal computeVolume (const UT_Vector3 &ref_P, int seg=0) const
 
virtual GT_PrimitiveHandle doHarden () const
 
virtual GT_PrimitiveHandle doSoftCopy () const
 
virtual const
GT_ViewportRefineOptions
viewportRefineOptions () const
 
virtual const
GT_AttributeListHandle
getUniformAttributes () const
 
virtual const
GT_AttributeListHandle
getDetailAttributes () const
 
const GT_GEODetailListHandlesourceGeometry () const
 
void setSourceGeometry (const GT_GEODetailListHandle &g)
 
- Public Member Functions inherited from GT_Primitive
 GT_Primitive ()
 
 GT_Primitive (const GT_Primitive &src)
 
virtual ~GT_Primitive ()
 
virtual bool getUniqueID (int64 &id) const
 
const GT_TransformHandlegetPrimitiveTransform () const
 
void setPrimitiveTransform (const GT_TransformHandle &x)
 Set the transform for a the primitive. More...
 
GT_PrimitiveHandle clone () const
 
virtual bool hasDataArray (const char *name, GT_Owner owner_scope[], int num_owners, GT_Storage *storage=NULL, GT_Size *tuple_size=NULL) const
 
void setStaticGeometry (bool static_geo)
 Return true if the primitive represents geometry at frame 'fr'. More...
 
bool isStaticGeometry () const
 
bool isFrameInfoAvailable () const
 
bool getDataIdHash (int64 &hash, int segment=0, bool cache_data_id=false) const
 
virtual bool getTopologyVersion (int64 &version) const
 Returns the topology version for the primitive. More...
 
GT_DataArrayHandle findAttribute (const char *name, GT_Owner &owner, int segment) const
 
void dumpAttributeLists (const char *label, bool data_too) const
 print out all attribute lists More...
 
void dumpPrimitive () const
 
bool saveAttributeLists (UT_JSONWriter &w) const
 
GT_PrimitiveHandle harden () const
 
GT_PrimitiveHandle copyTransformed (const GT_TransformHandle &x, bool force=false) const
 
void refineCopyTransformFrom (const GT_Primitive &src)
 
GT_PrimitiveHandle attributeMerge (const GT_Primitive &src, const UT_StringMMPattern *vertex_pattern, const UT_StringMMPattern *point_pattern, const UT_StringMMPattern *uniform_pattern, const UT_StringMMPattern *detail_pattern) const
 
virtual GT_PrimitiveHandle doAttributeMerge (const GT_Primitive &src, const UT_StringMMPattern *vertex, const UT_StringMMPattern *point, const UT_StringMMPattern *uniform, const UT_StringMMPattern *detail) const
 The virtual implementation of attribute merging. More...
 
bool enlargeWidth (UT_BoundingBox boxes[], int nsegments, fpreal defwidth=-1) const
 
virtual const
GT_AttributeListHandle
getPointAttributes () const
 
virtual const
GT_AttributeListHandle
getVertexAttributes () const
 
const GT_AttributeListHandlegetAttributeList (GT_Owner owner) const
 
virtual const GT_DataArrayHandlegetVertexList () const
 
virtual GT_DataArrayHandle createPointNormals (int segment=0, const char *P="P", bool normalize=true, const fpreal32 *pntdata=NULL, GT_Storage store=GT_STORE_REAL32) const
 
- Public Member Functions inherited from UT_IntrusiveRefCounter< GT_Primitive >
SYS_FORCE_INLINE UT_IntrusiveRefCounter ()
 Default constructor: Sets counter to 0. More...
 
SYS_FORCE_INLINE UT_IntrusiveRefCounter (const UT_IntrusiveRefCounter &)
 Copy constructor: Sets counter to 0. More...
 
UT_IntrusiveRefCounteroperator= (const UT_IntrusiveRefCounter &)
 Assignment operator: Does not modify counter. More...
 
SYS_FORCE_INLINE uint32 use_count () const
 Return current counter. More...
 

Protected Member Functions

void doEnlargeBounds (UT_BoundingBox boxes[], int nsegs, bool forrender) const
 
- Protected Member Functions inherited from GT_Primitive
void enlargeP (UT_BoundingBox &box, const GT_AttributeListHandle &list, int segment) const
 
void enlargeP (UT_BoundingBox &B, const GT_DataArrayHandle &P) const
 Convenience method to enlarge a bounding box given a position attribute. More...
 
void enlargePw (UT_BoundingBox &B, const GT_DataArrayHandle &P) const
 
- Protected Member Functions inherited from UT_IntrusiveRefCounter< GT_Primitive >
SYS_FORCE_INLINE ~UT_IntrusiveRefCounter ()
 Destructor: Only derived classes can destruct this. More...
 

Protected Attributes

GT_PrimitiveHandle myGeometry
 
GT_TransformArrayHandle myTransforms
 
GT_GEOOffsetList myPackedPrimOffsets
 
GT_AttributeListHandle myUniform
 
GT_AttributeListHandle myDetail
 
GT_GEODetailListHandle mySourceGeometry
 

Additional Inherited Members

- Static Public Member Functions inherited from GT_Primitive
static int createPrimitiveTypeId ()
 
static GT_AttributeListHandle mergeAttributeLists (bool &changed, const GT_AttributeListHandle &src, const GT_AttributeListHandle &merge, const UT_StringMMPattern *pattern, const UT_StringMMPattern *alternate=NULL)
 
static bool computeVelocityRange (UT_Vector3 &vmin, UT_Vector3 &vmax, const GT_DataArrayHandle &v)
 
static GT_PrimitiveHandle refineDetail (const GU_ConstDetailHandle &detail, const GT_RefineParms *parms)
 
static GT_PrimitiveHandle refinePrimitive (const GT_PrimitiveHandle &primh, const GT_RefineParms *parms)
 
static voidoperator new (size_t size)
 
static voidoperator new (size_t size, void *p)
 
static void operator delete (void *p, size_t size)
 

Detailed Description

A primitive which instances another primitive

The instance primitive can have attribute lists:

  • detail: one for the whole primitive
  • uniform: one per instance The instance primitive does not pass these down when it refines.

Definition at line 26 of file GT_PrimInstance.h.

Constructor & Destructor Documentation

GT_PrimInstance::GT_PrimInstance ( )
GT_PrimInstance::GT_PrimInstance ( const GT_PrimitiveHandle geometry,
const GT_TransformArrayHandle transforms,
const GT_GEOOffsetList packed_prim_offsets = GT_GEOOffsetList(),
const GT_AttributeListHandle uniform = GT_AttributeListHandle(),
const GT_AttributeListHandle detail = GT_AttributeListHandle(),
const GT_GEODetailListHandle source = GT_GEODetailListHandle() 
)
GT_PrimInstance::GT_PrimInstance ( const GT_PrimInstance src)
virtual GT_PrimInstance::~GT_PrimInstance ( )
virtual

Member Function Documentation

virtual const char* GT_PrimInstance::className ( ) const
virtual

Interface from GT_Primitive

Implements GT_Primitive.

Reimplemented in GT_AlembicInstance, and GT_PrimPackedDetail.

GT_TransformArrayHandle GT_PrimInstance::combinedTransforms ( ) const

Return the transforms for instances, but combined with the transform for the primitive itself.

virtual fpreal GT_PrimInstance::computePerimeter ( int  seg = 0) const
virtual

Interface from GT_Primitive

Reimplemented from GT_Primitive.

virtual fpreal GT_PrimInstance::computeSurfaceArea ( int  seg = 0) const
virtual

Interface from GT_Primitive

Reimplemented from GT_Primitive.

virtual fpreal GT_PrimInstance::computeVolume ( const UT_Vector3 ref_P,
int  seg = 0 
) const
virtual

Interface from GT_Primitive

Reimplemented from GT_Primitive.

const GT_AttributeListHandle& GT_PrimInstance::detail ( ) const
inline

Return detail attributes.

Definition at line 88 of file GT_PrimInstance.h.

void GT_PrimInstance::doEnlargeBounds ( UT_BoundingBox  boxes[],
int  nsegs,
bool  forrender 
) const
protected
virtual GT_PrimitiveHandle GT_PrimInstance::doHarden ( ) const
virtual

Interface from GT_Primitive

Reimplemented from GT_Primitive.

Reimplemented in GT_PrimPackedDetail.

virtual GT_PrimitiveHandle GT_PrimInstance::doSoftCopy ( ) const
virtual

Interface from GT_Primitive

Implements GT_Primitive.

Reimplemented in GT_PrimPackedDetail.

virtual void GT_PrimInstance::enlargeBounds ( UT_BoundingBox  boxes[],
int  nsegs 
) const
inlinevirtual

Interface from GT_Primitive

Implements GT_Primitive.

Definition at line 43 of file GT_PrimInstance.h.

virtual void GT_PrimInstance::enlargeRenderBounds ( UT_BoundingBox  boxes[],
int  nsegs 
) const
inlinevirtual

Interface from GT_Primitive

Reimplemented from GT_Primitive.

Definition at line 45 of file GT_PrimInstance.h.

GT_Size GT_PrimInstance::entries ( void  ) const
inline

Return number of instances.

Definition at line 71 of file GT_PrimInstance.h.

GT_PrimitiveHandle GT_PrimInstance::expandInstanceTransforms ( ) const

If the geometry contained by this instance primitive is an instance primitive itself this method will expand the instances, by permuting the transform arrays, creating a single flattened array of transforms.

bool GT_PrimInstance::flattenInstances ( GT_Refine refiner,
const GT_RefineParms parms 
) const

Refine to individual pieces of geometry. This will create transformed copies of the geometry for each transform in the instance primitive

const GT_PrimitiveHandle& GT_PrimInstance::geometry ( ) const
inline

Return geometry to be instanced.

Definition at line 75 of file GT_PrimInstance.h.

virtual const GT_AttributeListHandle& GT_PrimInstance::getDetailAttributes ( ) const
inlinevirtual

Interface from GT_Primitive

Reimplemented from GT_Primitive.

Definition at line 62 of file GT_PrimInstance.h.

virtual int64 GT_PrimInstance::getMemoryUsage ( ) const
virtual

Interface from GT_Primitive

Implements GT_Primitive.

Reimplemented in GT_PrimPackedDetail.

virtual int GT_PrimInstance::getMotionSegments ( ) const
virtual

Interface from GT_Primitive

Implements GT_Primitive.

virtual int GT_PrimInstance::getPrimitiveType ( ) const
virtual

Interface from GT_Primitive

Reimplemented from GT_Primitive.

Reimplemented in GT_AlembicInstance.

virtual const GT_AttributeListHandle& GT_PrimInstance::getUniformAttributes ( ) const
inlinevirtual

Interface from GT_Primitive

Reimplemented from GT_Primitive.

Definition at line 60 of file GT_PrimInstance.h.

virtual void GT_PrimInstance::getVelocityRange ( UT_Vector3 vmin,
UT_Vector3 vmax,
const char *  attribute_name 
) const
virtual

Interface from GT_Primitive

Reimplemented from GT_Primitive.

virtual bool GT_PrimInstance::isSimplePrimitive ( int  primitive_type) const
virtual

When the generic refine method is called, if the primitive is a "simple" primitive, flattenInstances() will be called instead of refineToInstances().

Default method considers the following to be "simple"

  • GT_PRIM_POLYGON_MESH
  • GT_PRIM_POLYGON
  • GT_PRIM_SUBDIVISION_MESH
  • GT_PRIM_CURVE_MESH
  • GT_PRIM_CURVE
  • GT_PRIM_POINT_MESH
  • GT_PRIM_NUPATCH
  • GT_PRIM_CIRCLE
  • GT_PRIM_SPHERE
  • GT_PRIM_TUBE
  • GT_PRIM_HYPERBOLOID
  • GT_PRIM_CIRCLE_MESH
  • GT_PRIM_SPHERE_MESH
  • GT_PRIM_TUBE_MESH
  • GT_PRIM_HYPERBOLOID_MESH
bool GT_PrimInstance::isValid ( void  ) const
inline

Check valid.

Definition at line 67 of file GT_PrimInstance.h.

const GT_GEOOffsetList& GT_PrimInstance::packedPrimOffsets ( ) const
inline

Definition at line 91 of file GT_PrimInstance.h.

virtual bool GT_PrimInstance::refine ( GT_Refine refiner,
const GT_RefineParms parms = NULL 
) const
virtual

Interface from GT_Primitive

Reimplemented from GT_Primitive.

bool GT_PrimInstance::refineToInstances ( GT_Refine refiner,
const GT_RefineParms parms 
) const

Refine geometry to create new instance primitives for each refined primitive. For example, if you refine an instance primitive containing a GT_PrimPolygonMesh, the poly mesh will be refined to create individual polygons. Each of these will be added to the refiner contained in an instance primitive.

virtual bool GT_PrimInstance::save ( UT_JSONWriter w) const
virtual

Interface from GT_Primitive

Reimplemented from GT_Primitive.

Reimplemented in GT_PrimPackedDetail.

void GT_PrimInstance::setSourceGeometry ( const GT_GEODetailListHandle g)
inline

If the geometry being instanced comes from a GU_Detail, then the source geometry should be set to point to this geometry. This lets viewport decorations be rendered properly.

Definition at line 142 of file GT_PrimInstance.h.

const GT_GEODetailListHandle& GT_PrimInstance::sourceGeometry ( ) const
inline

If the geometry being instanced comes from a GU_Detail, then the source geometry should be set to point to this geometry. This lets viewport decorations be rendered properly.

Definition at line 140 of file GT_PrimInstance.h.

const GT_TransformArrayHandle& GT_PrimInstance::transforms ( ) const
inline

Return transforms for instances.

Definition at line 79 of file GT_PrimInstance.h.

GT_TransformArrayHandle& GT_PrimInstance::transforms ( )
inline

Non-const transform access (for appending new transforms).

Definition at line 82 of file GT_PrimInstance.h.

const GT_AttributeListHandle& GT_PrimInstance::uniform ( ) const
inline

Return uniform attributes.

Definition at line 85 of file GT_PrimInstance.h.

virtual bool GT_PrimInstance::updateGeoPrim ( const GU_ConstDetailHandle dtl,
const GT_RefineParms parms 
)
virtual

update any cached data for geometry and its attributes

Reimplemented from GT_Primitive.

Reimplemented in GABC_NAMESPACE::GABC_PackedInstance.

virtual const GT_ViewportRefineOptions& GT_PrimInstance::viewportRefineOptions ( ) const
virtual

Interface from GT_Primitive

Reimplemented from GT_Primitive.

Member Data Documentation

GT_AttributeListHandle GT_PrimInstance::myDetail
protected

Definition at line 157 of file GT_PrimInstance.h.

GT_PrimitiveHandle GT_PrimInstance::myGeometry
protected

Definition at line 153 of file GT_PrimInstance.h.

GT_GEOOffsetList GT_PrimInstance::myPackedPrimOffsets
protected

Definition at line 155 of file GT_PrimInstance.h.

GT_GEODetailListHandle GT_PrimInstance::mySourceGeometry
protected

Definition at line 158 of file GT_PrimInstance.h.

GT_TransformArrayHandle GT_PrimInstance::myTransforms
protected

Definition at line 154 of file GT_PrimInstance.h.

GT_AttributeListHandle GT_PrimInstance::myUniform
protected

Definition at line 156 of file GT_PrimInstance.h.


The documentation for this class was generated from the following file: