Locator Class Reference
Locator Class Reference
#include <MapExtractorInterface.h>
Class Description
Definition at line 217 of file MapExtractorInterface.h.
Inheritance diagram for Locator:
Public Member Functions | |
| Locator (Mapper *pMapper=0) | |
| ~Locator (void) | |
| virtual void | Prepare (void) |
| This is called once at the beginning. The locator node can initialize its own internal data during this call. More... | |
| virtual void | CleanUp (void) |
| Called once at the end of the map extraction. More... | |
| virtual bool | LocateSurfacePoint (mudbox::SurfacePoint &pPoint, const class TargetLocation &vTarget) |
| This function is responsible to locate a point on the source surface based on a surface point on the target surface. More... | |
| virtual QWidget * | UserInterface (void) |
| This function must create a new widget instance which provides an interface to the user to check and alter the current options for the locator node. More... | |
| virtual void | Serialize (mudbox::Stream &s) |
| The locator node must serialize its internal data members in this function. More... | |
| virtual bool | IsValid (void) |
| MapExtractor * | Extractor (void) const |
| This function returns a pointer to the address of the map extraction node which this locator node belongs to. More... | |
| void | SetMeshes (QVector< mudbox::SubdivisionLevel * > pInputs, QVector< mudbox::SubdivisionLevel * > pOutputs) |
| Call this function if there are more than one locators used in a map extraction node. More... | |
| Public Member Functions inherited from Node | |
| Node (const QString &sStringID="", const QString &sDisplayName="") | |
| Standard constructor. More... | |
| virtual | ~Node (void) |
| virtual void | Initialize (void) |
| void | LoadTemplate (const QString &sFileName="", bool bStartEvent=false) |
| Use an external XML file to initialize the attributes. More... | |
| void | SaveTemplate (const QString &sFileName="", bool bSaveOnlyVisible=false) |
| Save current attributes as an XML template. More... | |
| unsigned int | Version (void) const |
| Returns the current version of the node. This number increases when the content of the node changed (when ContentChanged() called). More... | |
| void | SetVersion (unsigned int iVersion) |
| Sets the current version number for the node. More... | |
| unsigned int | ReferenceCount (void) const |
| Returns the number of pointers referencing this node. More... | |
| Attribute * | ReferencePointer (unsigned int iIndex) const |
| Returns the address of an attribute which refers to this node. The type of the attribute is always aptr. More... | |
| Node * | ReferenceNode (unsigned int iIndex) const |
| Returns the address of a node referencing this node. More... | |
| virtual QString | Name (const ClassDesc *pClass=0) const |
| Deprecated. More... | |
| virtual void | SetName (const QString &sName) |
| Deprecated. More... | |
| virtual QString | StringID (const ClassDesc *pClass=0) const |
| Returns the string id of the node. More... | |
| virtual void | SetStringID (const QString &sStringID) |
| Sets the string id of the node. More... | |
| virtual QString | DisplayName (void) const |
| Returns the display name of the node. More... | |
| virtual void | SetDisplayName (const QString &sDisplayName) |
| Sets the display name of the node. More... | |
| virtual QString | HelpID (void) const |
| Returns the help entry id of the node. Can be overwritten in derived classes. More... | |
| virtual void | SetHelpID (const QString &sHelpID) |
| Sets the help entry id of the node. More... | |
| void | Annex (Node *pSource, const QString &sCategory="") |
| Relink all the attributes of the source node to this one. More... | |
| bool | IsKindOf (const ClassDesc *pClass) const |
| Returns true if this node is derived from the pClass class. More... | |
| void | ContentChanged (void) const |
| This function must be called if the content of the node is changed. More... | |
| virtual void | CheckValidity (DiagnosticLevel iLevel=dgnLevel2) const |
| Checks the validity of this node. More... | |
| virtual void | CopyTo (Node *pNode) const |
| virtual Node * | Duplicate (void) const |
| virtual void | OnNodeEvent (const Attribute &cAttribute, NodeEventType cType) |
| This function is called if an event occurs with any of the attributes of the node. More... | |
| virtual void | OnEvent (const EventGate &cEvent) |
| This function is called when a generic event occurs. See EventGate class. More... | |
| void | RequestDeferredEvent (Attribute &cAttribute) |
| Request for a deferred event, which will occur only in the main loop. More... | |
| unsigned int | AttributeCount (void) const |
| Returns the number of attributes owned by the node. More... | |
| Attribute * | AttributeByIndex (int iIndex) const |
| Returns a specified attribute (or 0 if iIndex is greater than the number of attributes). More... | |
| Attribute * | AttributeByName (const QString &sName) const |
| Returns a specified attribute by its name. Returns 0 if the attribute not found. More... | |
| Attribute * | AttributeByID (const QString &sID) const |
| Returns a specified attribute by its ID. Returns 0 if the attribute not found. More... | |
| void | SetAttributeValue (const QString &sAttributeID, const QString &sNewValue) |
| Set the value of an attribute from a string. More... | |
| QString | AttributeValue (const QString &sAttributeID) const |
| Returns the current value of an attribute as a string. More... | |
| void | LogAttributes (void) const |
| Write all attributes into the log file. More... | |
| virtual QWidget * | CreatePropertiesWindow (QWidget *pParent) |
| Create a window which displays the attributes of the node. Can be overriden to provide a custom interface. More... | |
| Attribute * | AddAttribute (Attribute::AttributeType type, const QString &id) |
| Allows SDK users to add attributes at runtime. More... | |
| Node * | Next (void) const |
| Returns the next node in the chain. Used to enumerate the current nodes. See also First(). More... | |
| int | ID (void) const |
| Returns an ID for the node. The ID is unique in the whole application life. More... | |
| bool | SetID (int iID) |
| Set ID for the node. More... | |
Public Attributes | |
| QVector< mudbox::SubdivisionLevel * > | m_pInputs |
| QVector< mudbox::SubdivisionLevel * > | m_pOutputs |
| Mapper * | m_pMapper |
| Public Attributes inherited from Node | |
| AttributeThisPointer | m_pThis |
| DECLARE_CLASS | |
Friends | |
| class | Mapper |
Additional Inherited Members | |
| Public Types inherited from Node | |
| enum | DiagnosticLevel { dgnLevel1, dgnLevel2, dgnLevel3 } |
| Indicates the level of validity checking that is performed in CheckValidity() More... | |
| Static Public Member Functions inherited from Node | |
| static void | StartHashing () |
| This is called once in main once static ctors are done. More... | |
| static Node * | First (void) |
| This function will return the first node in the memory. Used to enumerate all the current nodes. See also Next(). More... | |
| static Node * | ByID (int iID) |
| Returns the node with the specified ID, or zero if such a node does not exists. More... | |
| static Node * | ByName (const QString &sClass, const QString &sName) |
| Search for a node with the name sName. More... | |
Constructor & Destructor Documentation
Definition at line 221 of file MapExtractorInterface.h.
Definition at line 222 of file MapExtractorInterface.h.
Member Function Documentation
This is called once at the beginning. The locator node can initialize its own internal data during this call.
Definition at line 224 of file MapExtractorInterface.h.
Called once at the end of the map extraction.
Definition at line 226 of file MapExtractorInterface.h.
|
virtual |
This function is responsible to locate a point on the source surface based on a surface point on the target surface.
The function has to fill the pPoint structure with the result. This function must be thread safe.
This function must create a new widget instance which provides an interface to the user to check and alter the current options for the locator node.
|
virtual |
The locator node must serialize its internal data members in this function.
Reimplemented from Node.
|
virtual |
| MapExtractor* Extractor | ( | void | ) | const |
This function returns a pointer to the address of the map extraction node which this locator node belongs to.
| void SetMeshes | ( | QVector< mudbox::SubdivisionLevel * > | pInputs, |
| QVector< mudbox::SubdivisionLevel * > | pOutputs | ||
| ) |
Call this function if there are more than one locators used in a map extraction node.
Friends And Related Function Documentation
|
friend |
Definition at line 245 of file MapExtractorInterface.h.
Member Data Documentation
| QVector<mudbox::SubdivisionLevel *> m_pInputs |
Definition at line 241 of file MapExtractorInterface.h.
| QVector<mudbox::SubdivisionLevel *> m_pOutputs |
Definition at line 241 of file MapExtractorInterface.h.
| Mapper* m_pMapper |
Definition at line 242 of file MapExtractorInterface.h.
The documentation for this class was generated from the following file:
- MapExtractor/MapExtractorInterface.h