IECoreMaya::ProceduralHolder Class Reference

#include <ProceduralHolder.h>

Inheritance diagram for IECoreMaya::ProceduralHolder:

List of all members.

Public Member Functions
	ProceduralHolder ()
virtual	~ProceduralHolder ()
virtual void	postConstructor ()
virtual bool	isBounded () const
virtual MBoundingBox	boundingBox () const
virtual MStatus	setDependentsDirty (const MPlug &plug, MPlugArray &plugArray)
virtual MStatus	compute (const MPlug &plug, MDataBlock &dataBlock)
virtual void	componentToPlugs (MObject &component, MSelectionList &selectionList) const
virtual MatchResult	matchComponent (const MSelectionList &item, const MAttributeSpecArray &spec, MSelectionList &list)
MStatus	setProcedural (const std::string &className, int classVersion)
	Calls setParameterised( className, classVersion, "IECORE_PROCEDURAL_PATHS" ).
IECore::ParameterisedProceduralPtr	getProcedural (std::string *className=0, int *classVersion=0)
	Returns runTimeCast<ParameterisedProcedural>( getProcedural( className, classVersion ) ).
IECoreGL::ConstScenePtr	scene ()
	Returns an up to date scene from the procedural.
Static Public Member Functions
static void *	creator ()
static MStatus	initialize ()
Static Public Attributes
static MTypeId	id = ProceduralHolderId
static MObject	aGLPreview
static MObject	aTransparent
static MObject	aDrawBound
static MObject	aDrawCoordinateSystems
static MObject	aProceduralComponents
static MObject	aComponentQueries
static MObject	aComponentTransform
static MObject	aComponentTranslate
static MObject	aComponentTranslateX
static MObject	aComponentTranslateY
static MObject	aComponentTranslateZ
static MObject	aComponentRotate
static MObject	aComponentRotateX
static MObject	aComponentRotateY
static MObject	aComponentRotateZ
static MObject	aComponentScale
static MObject	aComponentScaleX
static MObject	aComponentScaleY
static MObject	aComponentScaleZ
static MObject	aComponentBound
static MObject	aComponentBoundMin
static MObject	aComponentBoundMinX
static MObject	aComponentBoundMinY
static MObject	aComponentBoundMinZ
static MObject	aComponentBoundMax
static MObject	aComponentBoundMaxX
static MObject	aComponentBoundMaxY
static MObject	aComponentBoundMaxZ
static MObject	aComponentBoundCenter
static MObject	aComponentBoundCenterX
static MObject	aComponentBoundCenterY
static MObject	aComponentBoundCenterZ
Friends
class	ProceduralHolderUI

---

Detailed Description

The ProceduralHolder class represents implementation of the IECore::Renderer::Procedural class, presenting the procedural parameters as maya attributes. It also draws a bounding box for the procedural in the scene.

---

Constructor & Destructor Documentation

ProceduralHolder::ProceduralHolder

(

)

References IECore::ClassData< ClassTypeT, DataTypeT, DataDeletePolicyT >::create().

ProceduralHolder::~ProceduralHolder

(

)

[virtual]

References IECore::ClassData< ClassTypeT, DataTypeT, DataDeletePolicyT >::erase().

---

Member Function Documentation

MBoundingBox ProceduralHolder::boundingBox

(

)

const [virtual]

References getProcedural(), IECore::msg(), and IECoreMaya::ParameterisedHolder< BaseType >::setParameterisedValues().

Referenced by IECoreMaya::IECoreMaya::ProceduralHolderUI::draw(), and IECoreMaya::IECoreMaya::ProceduralHolderUI::select().

void ProceduralHolder::componentToPlugs	(	MObject &	component,
		MSelectionList &	selectionList
	)			const [virtual]

References aProceduralComponents.

MStatus ProceduralHolder::compute	(	const MPlug &	plug,
		MDataBlock &	dataBlock
	)			[virtual]

References aComponentBound, aComponentBoundCenter, aComponentBoundMax, aComponentBoundMin, aComponentQueries, aComponentRotate, aComponentScale, aComponentTransform, aComponentTranslate, IECore::radiansToDegrees(), and scene().

void * ProceduralHolder::creator

(

)

[static]

Reimplemented from IECoreMaya::ParameterisedHolder< BaseType >.

Referenced by IECoreMaya::initialize().

IECore::ParameterisedProceduralPtr ProceduralHolder::getProcedural	(	std::string *	className = 0,
		int *	classVersion = 0
	)

Returns runTimeCast<ParameterisedProcedural>( getProcedural( className, classVersion ) ).

References IECoreMaya::ParameterisedHolder< BaseType >::getParameterised().

Referenced by boundingBox(), and IECoreMaya::DelightProceduralCacheCommand::doIt().

MStatus ProceduralHolder::initialize

(

)

[static]

Reimplemented from IECoreMaya::ParameterisedHolder< BaseType >.

References aComponentBound, aComponentBoundCenter, aComponentBoundCenterX, aComponentBoundCenterY, aComponentBoundCenterZ, aComponentBoundMax, aComponentBoundMaxX, aComponentBoundMaxY, aComponentBoundMaxZ, aComponentBoundMin, aComponentBoundMinX, aComponentBoundMinY, aComponentBoundMinZ, aComponentQueries, aComponentRotate, aComponentRotateX, aComponentRotateY, aComponentRotateZ, aComponentScale, aComponentScaleX, aComponentScaleY, aComponentScaleZ, aComponentTransform, aComponentTranslate, aComponentTranslateX, aComponentTranslateY, aComponentTranslateZ, aDrawBound, aDrawCoordinateSystems, aGLPreview, aProceduralComponents, aTransparent, IECoreGL::State::defaultState(), and IECoreMaya::ParameterisedHolder< MPxComponentShape >::typeName.

Referenced by IECoreMaya::initialize().

bool ProceduralHolder::isBounded

(

)

const [virtual]

MPxSurfaceShape::MatchResult ProceduralHolder::matchComponent	(	const MSelectionList &	item,
		const MAttributeSpecArray &	spec,
		MSelectionList &	list
	)			[virtual]

void ProceduralHolder::postConstructor

(

)

[virtual]

Reimplemented from IECoreMaya::ParameterisedHolder< BaseType >.

IECoreGL::ConstScenePtr ProceduralHolder::scene

(

)

Returns an up to date scene from the procedural.

Todo:

Consider how we might modify the ParameterisedProcedural (and possibly Renderer::Procedural?) interface to properly support rerendering. Do this in conjunction with the todo in IECoreGL::Renderer::command() (about formalising a proper interface for specifying scene edits to a Renderer).

References aDrawCoordinateSystems, IECore::msg(), and IECoreMaya::ParameterisedHolder< BaseType >::setParameterisedValues().

Referenced by compute(), IECoreMaya::IECoreMaya::ProceduralHolderUI::draw(), and IECoreMaya::IECoreMaya::ProceduralHolderUI::select().

MStatus ProceduralHolder::setDependentsDirty	(	const MPlug &	plug,
		MPlugArray &	plugArray
	)			[virtual]

Reimplemented from IECoreMaya::ParameterisedHolder< BaseType >.

References aComponentBound, aComponentTransform, aDrawCoordinateSystems, and IECoreMaya::ParameterisedHolder< BaseType >::g_attributeNamePrefix.

MStatus ProceduralHolder::setProcedural	(	const std::string &	className,
		int	classVersion
	)

Calls setParameterised( className, classVersion, "IECORE_PROCEDURAL_PATHS" ).

References IECoreMaya::ParameterisedHolder< BaseType >::setParameterised().

---

Friends And Related Function Documentation

friend class ProceduralHolderUI [friend]

---

Member Data Documentation

MObject ProceduralHolder::aComponentBound [static]

Referenced by compute(), initialize(), and setDependentsDirty().

MObject ProceduralHolder::aComponentBoundCenter [static]

Referenced by compute(), and initialize().

MObject ProceduralHolder::aComponentBoundCenterX [static]

Referenced by initialize().

MObject ProceduralHolder::aComponentBoundCenterY [static]

Referenced by initialize().

MObject ProceduralHolder::aComponentBoundCenterZ [static]

Referenced by initialize().

MObject ProceduralHolder::aComponentBoundMax [static]

Referenced by compute(), and initialize().

MObject ProceduralHolder::aComponentBoundMaxX [static]

Referenced by initialize().

MObject ProceduralHolder::aComponentBoundMaxY [static]

Referenced by initialize().

MObject ProceduralHolder::aComponentBoundMaxZ [static]

Referenced by initialize().

MObject ProceduralHolder::aComponentBoundMin [static]

Referenced by compute(), and initialize().

MObject ProceduralHolder::aComponentBoundMinX [static]

Referenced by initialize().

MObject ProceduralHolder::aComponentBoundMinY [static]

Referenced by initialize().

MObject ProceduralHolder::aComponentBoundMinZ [static]

Referenced by initialize().

MObject ProceduralHolder::aComponentQueries [static]

Referenced by compute(), and initialize().

MObject ProceduralHolder::aComponentRotate [static]

Referenced by compute(), and initialize().

MObject ProceduralHolder::aComponentRotateX [static]

Referenced by initialize().

MObject ProceduralHolder::aComponentRotateY [static]

Referenced by initialize().

MObject ProceduralHolder::aComponentRotateZ [static]

Referenced by initialize().

MObject ProceduralHolder::aComponentScale [static]

Referenced by compute(), and initialize().

MObject ProceduralHolder::aComponentScaleX [static]

Referenced by initialize().

MObject ProceduralHolder::aComponentScaleY [static]

Referenced by initialize().

MObject ProceduralHolder::aComponentScaleZ [static]

Referenced by initialize().

MObject ProceduralHolder::aComponentTransform [static]

Referenced by compute(), initialize(), and setDependentsDirty().

MObject ProceduralHolder::aComponentTranslate [static]

Referenced by compute(), and initialize().

MObject ProceduralHolder::aComponentTranslateX [static]

Referenced by initialize().

MObject ProceduralHolder::aComponentTranslateY [static]

Referenced by initialize().

MObject ProceduralHolder::aComponentTranslateZ [static]

Referenced by initialize().

MObject ProceduralHolder::aDrawBound [static]

Referenced by IECoreMaya::IECoreMaya::ProceduralHolderUI::getDrawRequests(), initialize(), and IECoreMaya::IECoreMaya::ProceduralHolderUI::select().

MObject ProceduralHolder::aDrawCoordinateSystems [static]

Referenced by initialize(), scene(), and setDependentsDirty().

MObject ProceduralHolder::aGLPreview [static]

Referenced by IECoreMaya::IECoreMaya::ProceduralHolderUI::getDrawRequests(), and initialize().

MObject ProceduralHolder::aProceduralComponents [static]

Referenced by componentToPlugs(), and initialize().

MObject ProceduralHolder::aTransparent [static]

Referenced by IECoreMaya::IECoreMaya::ProceduralHolderUI::getDrawRequests(), and initialize().

MTypeId ProceduralHolder::id = ProceduralHolderId [static]

This is a template class instantiated into many different classes, so we specialise these in the implementation.

Reimplemented from IECoreMaya::ParameterisedHolder< BaseType >.

Referenced by IECoreMaya::initialize(), and IECoreMaya::uninitialize().

---

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

• include/IECoreMaya/ProceduralHolder.h
• src/IECoreMaya/ProceduralHolder.cpp