Cortex  10.0.0-a4
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
IECore::SpherePrimitiveEvaluator Class Reference

#include <SpherePrimitiveEvaluator.h>

+ Inheritance diagram for IECore::SpherePrimitiveEvaluator:

Public Types

typedef SpherePrimitive PrimitiveType
 
- Public Types inherited from IECore::PrimitiveEvaluator
typedef PrimitiveEvaluatorPtr(* CreatorFn) (ConstPrimitivePtr)
 
- Public Types inherited from IECore::RunTimeTyped
typedef RefCounted BaseClass
 A typedef for the class this class derives from. All RunTimeTyped classes define this typedef.
 
- Public Types inherited from IECore::RefCounted
typedef size_t RefCount
 

Public Member Functions

 IE_CORE_DECLARERUNTIMETYPED (SpherePrimitiveEvaluator, PrimitiveEvaluator)
 
 IE_CORE_DECLAREPTR (Result)
 
 SpherePrimitiveEvaluator (ConstSpherePrimitivePtr sphere)
 
ConstPrimitivePtr primitive () const override
 Returns the primitive which we're currently evaluating.
 
PrimitiveEvaluator::ResultPtr createResult () const override
 Create a result instance which is suitable for passing to one of the query methods.
 
void validateResult (PrimitiveEvaluator::Result *result) const override
 Throws an exception if the passed result type is not compatible with the current evaluator.
 
bool closestPoint (const Imath::V3f &p, PrimitiveEvaluator::Result *result) const override
 
bool pointAtUV (const Imath::V2f &uv, PrimitiveEvaluator::Result *result) const override
 Find the point on the primitive at the given query UV. Returns true on success.
 
bool intersectionPoint (const Imath::V3f &origin, const Imath::V3f &direction, PrimitiveEvaluator::Result *result, float maxDistance=Imath::limits< float >::max()) const override
 
int intersectionPoints (const Imath::V3f &origin, const Imath::V3f &direction, std::vector< PrimitiveEvaluator::ResultPtr > &results, float maxDistance=Imath::limits< float >::max()) const override
 
float volume () const override
 Computes the volume of the primitive. The result is undefined if the primitive is not closed, or self intersects.
 
Imath::V3f centerOfGravity () const override
 Computes the primitive's center of gravity. The result is undefined if the primitive is not closed, or self intersects.
 
float surfaceArea () const override
 Computes the surface area of the primitive.
 
- Public Member Functions inherited from IECore::PrimitiveEvaluator
 IE_CORE_DECLARERUNTIMETYPED (PrimitiveEvaluator, RunTimeTyped)
 
 IE_CORE_DECLAREPTR (Result)
 
virtual bool signedDistance (const Imath::V3f &p, float &distance, Result *result) const
 
virtual int intersectionPoints (const Imath::V3f &origin, const Imath::V3f &direction, std::vector< ResultPtr > &results, float maxDistance=Imath::limits< float >::max()) const =0
 
- Public Member Functions inherited from IECore::RunTimeTyped
 IE_CORE_DECLAREMEMBERPTR (RunTimeTyped)
 
virtual TypeId typeId () const
 
virtual const char * typeName () const
 
virtual bool isInstanceOf (TypeId typeId) const
 
virtual bool isInstanceOf (const char *typeName) const
 
- Public Member Functions inherited from IECore::RefCounted
 IE_CORE_DECLAREMEMBERPTR (RefCounted)
 
void addRef () const
 Add a reference to the current object.
 
void removeRef () const
 Remove a reference from the current object.
 
RefCount refCount () const
 Returns the current reference count.
 

Static Public Member Functions

static PrimitiveEvaluatorPtr create (ConstPrimitivePtr primitive)
 
- Static Public Member Functions inherited from IECore::PrimitiveEvaluator
static PrimitiveEvaluatorPtr create (ConstPrimitivePtr primitive)
 
- Static Public Member Functions inherited from IECore::RunTimeTyped
static TypeId staticTypeId ()
 Returns the TypeId for this class, without needing an instance.
 
static const char * staticTypeName ()
 Returns the type name for this class, without needing an instance.
 
static TypeId baseTypeId ()
 
static const char * baseTypeName ()
 
static bool inheritsFrom (TypeId typeId)
 Returns true if this class inherits from the specified type.
 
static bool inheritsFrom (const char *typeName)
 Returns true if this class inherits from the specified type.
 
static bool inheritsFrom (TypeId type, TypeId baseType)
 Returns true if type inherits from baseType.
 
static bool inheritsFrom (const char *typeName, const char *baseTypeName)
 Returns true if typeName inherits from baseTypeName.
 
static TypeId baseTypeId (TypeId typeId)
 Returns the base type of the given type, or InvalidTypeId if no such base exists.
 
static const std::vector< TypeId > & baseTypeIds (TypeId typeId)
 
static const std::set< TypeId > & derivedTypeIds (TypeId typeId)
 
static TypeId typeIdFromTypeName (const char *typeName)
 
static const char * typeNameFromTypeId (TypeId typeId)
 
static void registerType (TypeId derivedTypeId, const char *derivedTypeName, TypeId baseTypeId)
 Allows external modules to register their own type ids.
 

Protected Attributes

ConstSpherePrimitivePtr m_sphere
 

Additional Inherited Members

- Protected Types inherited from IECore::RunTimeTyped
typedef std::map< TypeId, TypeIdBaseTypeRegistryMap
 
typedef std::map< TypeId, std::vector< TypeId > > BaseTypesRegistryMap
 
typedef std::map< TypeId, std::set< TypeId > > DerivedTypesRegistryMap
 
typedef tbb::spin_rw_mutex Mutex
 
typedef std::map< TypeId, std::string > TypeIdsToTypeNamesMap
 
typedef std::map< std::string, TypeIdTypeNamesToTypeIdsMap
 
- Static Protected Member Functions inherited from IECore::RunTimeTyped
static BaseTypeRegistryMap & baseTypeRegistry ()
 
static DerivedTypesRegistryMap & derivedTypesRegistry ()
 
static BaseTypesRegistryMap & completeBaseTypesRegistry ()
 
static DerivedTypesRegistryMap & completeDerivedTypesRegistry ()
 
static void derivedTypeIdsWalk (TypeId typeId, std::set< TypeId > &)
 
static TypeIdsToTypeNamesMap & typeIdsToTypeNames ()
 
static TypeNamesToTypeIdsMap & typeNamesToTypeIds ()
 
- Static Protected Attributes inherited from IECore::RunTimeTyped
static Mutex g_baseTypeIdsMutex
 
static Mutex g_derivedTypeIdsMutex
 

Detailed Description

An implementation of PrimitiveEvaluator to allow spatial queries to be performed on spheres.

Todo:
Currently ignores zMin, zMax, thetaMax parameters, instead assuming that there sphere is whole and facing outwards.

Member Function Documentation

bool IECore::SpherePrimitiveEvaluator::closestPoint ( const Imath::V3f &  p,
PrimitiveEvaluator::Result result 
) const
overridevirtual

Find the closest point on the primitive to the given query point. Returns true on success.

Todo:
Extend this to pass a maximum distance past which results are no longer interesting.

Implements IECore::PrimitiveEvaluator.

bool IECore::SpherePrimitiveEvaluator::intersectionPoint ( const Imath::V3f &  origin,
const Imath::V3f &  direction,
PrimitiveEvaluator::Result result,
float  maxDistance = Imath::limits< float >::max() 
) const
overridevirtual

Finds the closest intersection point for the given ray. Optionally specify a maximum distance of interest. Returns true if an intersection was found.

Implements IECore::PrimitiveEvaluator.


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