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

#include <RandomRotationOp.h>

+ Inheritance diagram for IECore::RandomRotationOp:

Public Member Functions

 IE_CORE_DECLARERUNTIMETYPED (RandomRotationOp, Op)
 
ObjectParameterseedParameter ()
 
const ObjectParameterseedParameter () const
 
FloatParametertimeParameter ()
 
const FloatParametertimeParameter () const
 
FloatParameterspeedMinParameter ()
 
const FloatParameterspeedMinParameter () const
 
FloatParameterspeedMaxParameter ()
 
const FloatParameterspeedMaxParameter () const
 
- Public Member Functions inherited from IECore::Op
 IE_CORE_DECLARERUNTIMETYPED (Op, Parameterised)
 
 Op (const std::string &description, ParameterPtr resultParameter)
 
 Op (const std::string &description, CompoundParameterPtr compoundParameter, ParameterPtr resultParameter)
 
ObjectPtr operate ()
 
ObjectPtr operate (const CompoundObject *operands)
 Performs the operation using the given values of parameters.
 
const ParameterresultParameter () const
 
- Public Member Functions inherited from IECore::Parameterised
 IE_CORE_DECLARERUNTIMETYPED (Parameterised, RunTimeTyped)
 
 Parameterised (const std::string &description)
 
 Parameterised (const std::string &description, CompoundParameterPtr compoundParameter)
 Another constructor added later on that gives defines the CompoundParameter object to be hold in this Parameterised instance.
 
const std::string & description () const
 Returns a description for this parameterised object.
 
CompoundParameterparameters () override
 
const CompoundParameterparameters () const override
 Returns the parameters for query.
 
CompoundObjectuserData ()
 Returns an object that anyone can use for storing anything.
 
const CompoundObjectuserData () const
 Read only version of the above.
 
- 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

template<typename SeedIt , typename OutputIt >
static void generate (SeedIt seedBegin, SeedIt seedEnd, typename std::iterator_traits< OutputIt >::value_type::BaseType time, typename std::iterator_traits< OutputIt >::value_type::BaseType speedMin, typename std::iterator_traits< OutputIt >::value_type::BaseType speedMax, OutputIt result)
 
- 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 Member Functions

ObjectPtr doOperation (const CompoundObject *operands) override
 

Additional Inherited Members

- 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
 
- 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

The RandomRotationOp calculates a set of random vectors which rotate coherently over time.

Member Function Documentation

ObjectPtr IECore::RandomRotationOp::doOperation ( const CompoundObject operands)
overrideprotectedvirtual

Called by operate() to actually perform the operation. operands contains the result of parameters()->getValidatedValue - this function will never be called when the contents of the parameters are in a bad state.

Todo:
This should be const.

Implements IECore::Op.

template<typename SeedIt , typename OutputIt >
static void IECore::RandomRotationOp::generate ( SeedIt  seedBegin,
SeedIt  seedEnd,
typename std::iterator_traits< OutputIt >::value_type::BaseType  time,
typename std::iterator_traits< OutputIt >::value_type::BaseType  speedMin,
typename std::iterator_traits< OutputIt >::value_type::BaseType  speedMax,
OutputIt  result 
)
static

The core algorithm, for those who want direct access from C++ without all the Op wrapping.


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