TransferDetailOperation Class Reference

TransferDetailOperation Class Reference

#include <generaloperations.h>

Class Description

This Operation transfers the sculpting detail from one mesh to another.

This operation is equivalent to the Transfer Details function within the Mudbox UI.

Definition at line 135 of file generaloperations.h.

+ Inheritance diagram for TransferDetailOperation:

Public Member Functions

virtual void SetSourceGeometry (Geometry *pSource)
 Set the source geometry for the operation. More...
 
virtual void SetTargetGeometry (Geometry *pTarget)
 Set the target geometry for the operation. More...
 
virtual void SetSearchDistance (float f)
 Sets the search distance used for the detail transfer. More...
 
virtual float SearchDistance () const
 Returns the search distance used for the detail transfer. More...
 
virtual void SetTransferOntoNewLayer (bool bNewLayer)
 Sets whether or not the transfered details are put onto a new sculpt layer. More...
 
virtual bool TransferOntoNewLayer () const
 Returns whether or not the transfered details are put onto a new sculpt layer. More...
 
virtual void SetTransferSculptLayers (bool bTransfer)
 Sets whether or not sculpt layers on the source are transfered to the target. More...
 
virtual bool TransferSculptLayers () const
 Returns whether or not sculpt layers on the source are transfered to the target. More...
 
virtual void SetTransferJointWeights (bool bTransfer)
 Sets whether or not joint weights on the source are transfered to the target. More...
 
virtual bool TransferJointWeights () const
 Returns whether or not joint weights on the source are transfered to the target. More...
 
virtual void SetSelectDirtyRegions (bool bSelect)
 Sets whether the dirty regions of the source are selected at the end of the transfer. More...
 
virtual bool SelectDirtyRegions () const
 Returns whether the dirty regions of the source are selected at the end of the transfer. More...
 
virtual void SetTestBothSides (bool bTest)
 Sets if both sides are considered in the transfer. More...
 
virtual bool TestBothSides () const
 Returns if both sides are considered in the transfer. More...
 
virtual void SetSearchMethod (int iMethod)
 Sets the search method used in the transfer. More...
 
virtual int SearchMethod () const
 Returns the search method used in the transfer. More...
 
virtual void SetTargetSubdivisionLevel (int iLevel)
 Sets the number of subdivision levels that the target will be subdivided to. More...
 
virtual int TargetSubdivisionLevel () const
 Returns the number of subdivision levels that the target will be subdivided to. More...
 
virtual QWidgetCreatePropertiesWindow (QWidget *pParent, bool bMinimal=false)
 Convenience method to create a modal settings dialog for the transfer operation. 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...
 
AttributeReferencePointer (unsigned int iIndex) const
 Returns the address of an attribute which refers to this node. The type of the attribute is always aptr. More...
 
NodeReferenceNode (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...
 
virtual void Serialize (Stream &s)
 Serializes the node. 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 NodeDuplicate (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...
 
AttributeAttributeByIndex (int iIndex) const
 Returns a specified attribute (or 0 if iIndex is greater than the number of attributes). More...
 
AttributeAttributeByName (const QString &sName) const
 Returns a specified attribute by its name. Returns 0 if the attribute not found. More...
 
AttributeAttributeByID (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 QWidgetCreatePropertiesWindow (QWidget *pParent)
 Create a window which displays the attributes of the node. Can be overriden to provide a custom interface. More...
 
AttributeAddAttribute (Attribute::AttributeType type, const QString &id)
 Allows SDK users to add attributes at runtime. More...
 
NodeNext (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...
 

Protected Member Functions

 TransferDetailOperation ()
 

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 NodeFirst (void)
 This function will return the first node in the memory. Used to enumerate all the current nodes. See also Next(). More...
 
static NodeByID (int iID)
 Returns the node with the specified ID, or zero if such a node does not exists. More...
 
static NodeByName (const QString &sClass, const QString &sName)
 Search for a node with the name sName. More...
 
- Public Attributes inherited from Node
AttributeThisPointer m_pThis
 
 DECLARE_CLASS
 

Constructor & Destructor Documentation

TransferDetailOperation ( )
protected

Member Function Documentation

virtual void SetSourceGeometry ( Geometry pSource)
virtual

Set the source geometry for the operation.

Note the active subdivision level is used for the transfer.

virtual void SetTargetGeometry ( Geometry pTarget)
virtual

Set the target geometry for the operation.

virtual void SetSearchDistance ( float  f)
virtual

Sets the search distance used for the detail transfer.

See the corresponding tooltip in the transfer details UI for more information.

virtual float SearchDistance ( ) const
virtual

Returns the search distance used for the detail transfer.

See the corresponding tooltip in the transfer details UI for more information.

virtual void SetTransferOntoNewLayer ( bool  bNewLayer)
virtual

Sets whether or not the transfered details are put onto a new sculpt layer.

virtual bool TransferOntoNewLayer ( ) const
virtual

Returns whether or not the transfered details are put onto a new sculpt layer.

virtual void SetTransferSculptLayers ( bool  bTransfer)
virtual

Sets whether or not sculpt layers on the source are transfered to the target.

virtual bool TransferSculptLayers ( ) const
virtual

Returns whether or not sculpt layers on the source are transfered to the target.

virtual void SetTransferJointWeights ( bool  bTransfer)
virtual

Sets whether or not joint weights on the source are transfered to the target.

virtual bool TransferJointWeights ( ) const
virtual

Returns whether or not joint weights on the source are transfered to the target.

virtual void SetSelectDirtyRegions ( bool  bSelect)
virtual

Sets whether the dirty regions of the source are selected at the end of the transfer.

The dirty regions, are regions of the mesh that did not transfer successfully.

virtual bool SelectDirtyRegions ( ) const
virtual

Returns whether the dirty regions of the source are selected at the end of the transfer.

virtual void SetTestBothSides ( bool  bTest)
virtual

Sets if both sides are considered in the transfer.

See the corresponding tooltip in the Transfer Details UI for more information.

virtual bool TestBothSides ( ) const
virtual

Returns if both sides are considered in the transfer.

virtual void SetSearchMethod ( int  iMethod)
virtual

Sets the search method used in the transfer.

See the corresponding tooltip in the Transfer Details UI for more information.

virtual int SearchMethod ( ) const
virtual

Returns the search method used in the transfer.

virtual void SetTargetSubdivisionLevel ( int  iLevel)
virtual

Sets the number of subdivision levels that the target will be subdivided to.

Use -1 to automatically compute the level.

virtual int TargetSubdivisionLevel ( ) const
virtual

Returns the number of subdivision levels that the target will be subdivided to.

virtual QWidget* CreatePropertiesWindow ( QWidget pParent,
bool  bMinimal = false 
)
virtual

Convenience method to create a modal settings dialog for the transfer operation.

Parameters
[in]pParentThe parent widget, typical Kernel()->Interface()->MainWindow()
[in]bMinimalSet to true to hide the source and target widgets. Useful when the source are target are set programmatically, and should be fixed.

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