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

A circle primitive. More...

#include <GT_PrimCircle.h>

+ Inheritance diagram for GT_PrimCircle:

Public Member Functions

 GT_PrimCircle ()
 Default constructor (full unit circle in the xz plane, no attributes) More...
 
 GT_PrimCircle (const GT_AttributeListHandle &attribs, const GT_TransformHandle &transform, const GT_Parametric &uv=GT_Parametric())
 Useful constructor. More...
 
 GT_PrimCircle (const GT_PrimCircle &src, const GT_Parametric &uv)
 Copy (but with a different parametric range) More...
 
 GT_PrimCircle (const GT_PrimCircle &src)
 Copy constructor. More...
 
virtual ~GT_PrimCircle ()
 Destructor. More...
 
virtual const char * className () const
 
virtual bool save (UT_JSONWriter &w) const
 
virtual GT_PrimitiveHandle doSoftCopy () const
 
virtual GT_PrimitiveHandle doHarden () const
 
virtual GT_PrimitiveHandle refineToPolygonMesh (const GT_RefineParms *parms) const
 
GT_PrimitiveHandle refineToCurve (const GT_RefineParms *parms) const
 
bool init (const GT_AttributeListHandle &attribs, const GT_TransformHandle &transform, const GT_Parametric &uv)
 
virtual int getPrimitiveType () const
 
- Public Member Functions inherited from GT_PrimQuadric
 GT_PrimQuadric ()
 
 GT_PrimQuadric (const GT_AttributeListHandle &attribs, const GT_TransformHandle &transform, const GT_Parametric &uv=GT_Parametric())
 
 GT_PrimQuadric (const GT_PrimQuadric &src)
 
 GT_PrimQuadric (const GT_PrimQuadric &src, const GT_Parametric &uv)
 Copy the quadric, but with a different parametric range. More...
 
virtual ~GT_PrimQuadric ()
 
bool saveQuadric (UT_JSONWriter &w, const char *name) const
 
bool init (const GT_AttributeListHandle &attribs, const GT_TransformHandle &transform, const GT_Parametric &uv)
 
virtual bool refine (GT_Refine &refiner, const GT_RefineParms *parms) const
 Method defined on GT_Primitive. More...
 
virtual const
GT_ViewportRefineOptions
viewportRefineOptions () const
 Viewport refinement options. More...
 
virtual void enlargeBounds (UT_BoundingBox boxes[], int nsegments) const
 
virtual int getMotionSegments () const
 
virtual int64 getMemoryUsage () const
 
const GT_AttributeListHandlegetAttributes () const
 
const GT_ParametricgetParametric () const
 
virtual const
GT_AttributeListHandle
getDetailAttributes () const
 
GT_PrimitiveHandle splitU ()
 
GT_PrimitiveHandle splitV ()
 
void getQP (UT_Vector3F &P, fpreal u, fpreal v) const
 
void getQP (UT_Vector3D &P, fpreal u, fpreal v) const
 
void getQN (UT_Vector3F &N, fpreal u, fpreal v) const
 
void getQN (UT_Vector3D &N, fpreal u, fpreal v) const
 
- Public Member Functions inherited from GT_Primitive
 GT_Primitive ()
 
 GT_Primitive (const GT_Primitive &src)
 
virtual ~GT_Primitive ()
 
virtual bool getUniqueID (int64 &id) const
 
virtual void enlargeRenderBounds (UT_BoundingBox boxes[], int nsegments) const
 
virtual void getVelocityRange (UT_Vector3 &min, UT_Vector3 &max, const UT_StringRef &attribute_name=GA_Names::v) 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 UT_StringRef &name, GT_Owner owner_scope[], int num_owners, GT_Storage *storage=NULL, GT_Size *tuple_size=NULL) const
 
virtual bool updateGeoPrim (const GU_ConstDetailHandle &dtl, const GT_RefineParms &parms)
 update any cached data for geometry and its attributes More...
 
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 UT_StringRef &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
 
virtual const
GT_AttributeListHandle
getUniformAttributes () const
 
const GT_AttributeListHandlegetAttributeList (GT_Owner owner) const
 
virtual const GT_DataArrayHandlegetVertexList () const
 
virtual GT_DataArrayHandle createPointNormals (int segment=0, const UT_StringRef &P=GA_Names::P, bool normalize=true, const fpreal32 *pntdata=NULL, GT_Storage store=GT_STORE_REAL32) 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
 
- 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...
 

Static Public Member Functions

static void computeCircleBounds (UT_BoundingBox &box, const GT_Parametric &uv)
 Static method to compute bounds for a circle. More...
 
static GT_PrimitiveHandle makePolygonMesh (const GT_RefineParms *parms, UT_Axis3::axis axis=UT_Axis3::XAXIS, fpreal axis_trans=0.0f, fpreal radius=1.0f)
 
static GT_PrimitiveHandle makeCurve (const GT_RefineParms *parms, UT_Axis3::axis axis=UT_Axis3::XAXIS, fpreal axis_trans=0.0f, fpreal radius=1.0f)
 
- 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)
 

Protected Member Functions

virtual GT_PrimQuadricclone (const GT_Parametric &uv) const
 Create a split primitive. More...
 
virtual void getQBounds (UT_BoundingBox &box) const
 
virtual void fillQP (UT_Vector3F *P, GT_Size n, const fpreal *u, fpreal v) const
 
virtual void fillQP (UT_Vector3D *P, GT_Size n, const fpreal *u, fpreal v) const
 
virtual void fillQN (UT_Vector3F *P, GT_Size n, const fpreal *u, fpreal v) const
 
virtual void fillQN (UT_Vector3D *P, GT_Size n, const fpreal *u, fpreal v) const
 
virtual void adjustTesselationCounts (GT_Size &nu, GT_Size &nv) const
 
- Protected Member Functions inherited from GT_PrimQuadric
void hardenAttributes ()
 Harden attributes etc. More...
 
virtual GT_PrimitiveHandle createMesh (GT_Size nu, GT_Size nv, fpreal u0, fpreal u1, fpreal v0, fpreal v1, bool create_normals=true, bool create_uv=true, GT_Storage Pstorage=GT_STORE_REAL32, GT_Storage Nstorage=GT_STORE_REAL32) 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...
 

Additional Inherited Members

- Static Protected Member Functions inherited from GT_PrimQuadric
static void extractRefineParms (const GT_RefineParms *parms, GT_Size &nu, GT_Size &nv, fpreal &u0, fpreal &u1, fpreal &v0, fpreal &v1)
 Extract refinement parameters. More...
 
- Protected Attributes inherited from GT_PrimQuadric
GT_AttributeListHandle myAttributes
 
GT_Parametric myUV
 

Detailed Description

A circle primitive.

The circle primitive represents a parametric patch of a circle/disk primitive in the XY plane. The circle is parametrized so u (0 to 1) represents radial angle, while v (0 to 1) is goes from the center to the circumference. That is:

theta = u * 2*PI
x = cos(u)*v
y = sin(u)*v
z = 0

Definition at line 31 of file GT_PrimCircle.h.

Constructor & Destructor Documentation

GT_PrimCircle::GT_PrimCircle ( )
inline

Default constructor (full unit circle in the xz plane, no attributes)

Definition at line 35 of file GT_PrimCircle.h.

GT_PrimCircle::GT_PrimCircle ( const GT_AttributeListHandle attribs,
const GT_TransformHandle transform,
const GT_Parametric uv = GT_Parametric() 
)
inline

Useful constructor.

Definition at line 38 of file GT_PrimCircle.h.

GT_PrimCircle::GT_PrimCircle ( const GT_PrimCircle src,
const GT_Parametric uv 
)
inline

Copy (but with a different parametric range)

Definition at line 44 of file GT_PrimCircle.h.

GT_PrimCircle::GT_PrimCircle ( const GT_PrimCircle src)
inline

Copy constructor.

Definition at line 49 of file GT_PrimCircle.h.

virtual GT_PrimCircle::~GT_PrimCircle ( )
virtual

Destructor.

Member Function Documentation

virtual void GT_PrimCircle::adjustTesselationCounts ( GT_Size nu,
GT_Size nv 
) const
protectedvirtual

Methods defined on GT_PrimQuadric

Reimplemented from GT_PrimQuadric.

virtual const char* GT_PrimCircle::className ( void  ) const
inlinevirtual

Reimplemented from GT_PrimQuadric.

Definition at line 56 of file GT_PrimCircle.h.

virtual GT_PrimQuadric* GT_PrimCircle::clone ( const GT_Parametric uv) const
inlineprotectedvirtual

Create a split primitive.

Implements GT_PrimQuadric.

Definition at line 110 of file GT_PrimCircle.h.

static void GT_PrimCircle::computeCircleBounds ( UT_BoundingBox box,
const GT_Parametric uv 
)
static

Static method to compute bounds for a circle.

virtual GT_PrimitiveHandle GT_PrimCircle::doHarden ( ) const
virtual

Hardening the primitive will return a copy of the primitive, but without any dangling references. The default implementation returns a NULL ptr.

Reimplemented from GT_Primitive.

virtual GT_PrimitiveHandle GT_PrimCircle::doSoftCopy ( ) const
inlinevirtual

Create a copy of the primitive, referencing all the source data This can return a NULL pointer, but it would be better to implement it properly.

Implements GT_Primitive.

Definition at line 59 of file GT_PrimCircle.h.

virtual void GT_PrimCircle::fillQN ( UT_Vector3F P,
GT_Size  n,
const fpreal u,
fpreal  v 
) const
protectedvirtual

Methods defined on GT_PrimQuadric

Implements GT_PrimQuadric.

virtual void GT_PrimCircle::fillQN ( UT_Vector3D P,
GT_Size  n,
const fpreal u,
fpreal  v 
) const
protectedvirtual

Methods defined on GT_PrimQuadric

Implements GT_PrimQuadric.

virtual void GT_PrimCircle::fillQP ( UT_Vector3F P,
GT_Size  n,
const fpreal u,
fpreal  v 
) const
protectedvirtual

Methods defined on GT_PrimQuadric

Implements GT_PrimQuadric.

virtual void GT_PrimCircle::fillQP ( UT_Vector3D P,
GT_Size  n,
const fpreal u,
fpreal  v 
) const
protectedvirtual

Methods defined on GT_PrimQuadric

Implements GT_PrimQuadric.

virtual int GT_PrimCircle::getPrimitiveType ( ) const
virtual

Methods defined on GT_Primitive

Reimplemented from GT_Primitive.

virtual void GT_PrimCircle::getQBounds ( UT_BoundingBox box) const
protectedvirtual

Methods defined on GT_PrimQuadric

Implements GT_PrimQuadric.

bool GT_PrimCircle::init ( const GT_AttributeListHandle attribs,
const GT_TransformHandle transform,
const GT_Parametric uv 
)
inline

Initialize a circle with

Parameters
attribs
Attributes defined on the circle
transform
The transform attribute list should contain a single transform representing the 4x4 transform of the circle.
uv
The parametric range for the circle. The circle is parametrized so u (0 to 1) represents radial angle, while v (0 to 1) is goes from the center to the circumference.

Definition at line 85 of file GT_PrimCircle.h.

static GT_PrimitiveHandle GT_PrimCircle::makeCurve ( const GT_RefineParms parms,
UT_Axis3::axis  axis = UT_Axis3::XAXIS,
fpreal  axis_trans = 0.0f,
fpreal  radius = 1.0f 
)
static
static GT_PrimitiveHandle GT_PrimCircle::makePolygonMesh ( const GT_RefineParms parms,
UT_Axis3::axis  axis = UT_Axis3::XAXIS,
fpreal  axis_trans = 0.0f,
fpreal  radius = 1.0f 
)
static

Get a tesselation of a full circle with a given set of refinement parameters.

GT_PrimitiveHandle GT_PrimCircle::refineToCurve ( const GT_RefineParms parms) const
virtual GT_PrimitiveHandle GT_PrimCircle::refineToPolygonMesh ( const GT_RefineParms parms) const
virtual

When creating a polygon mesh from a circle, we can make a triangle fan instead of a mesh.

Reimplemented from GT_PrimQuadric.

virtual bool GT_PrimCircle::save ( UT_JSONWriter w) const
inlinevirtual

Save the primitive to a JSON stream. The default method does nothing and returns false.

Reimplemented from GT_Primitive.

Definition at line 57 of file GT_PrimCircle.h.


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