#include <mesh.h>

Class Description

This class represents a change to a mesh, and is used when an operation which modifies mesh vertices should be undoable.

When you want to change the position of vertices in a mesh, and you want this change to be undoable, you should first call the function Mesh::StartChange to create a MeshChange object.

Definition at line 1475 of file mesh.h.

Inheritance diagram for MeshChange:

Public Types
typedef StoredVertexInfo	VertexChange
	This struct holds the change information about a single vertex. More...

Public Types inherited from Node
enum	DiagnosticLevel { dgnLevel1, dgnLevel2, dgnLevel3 }
	Indicates the level of validity checking that is performed in CheckValidity() More...

Public Member Functions
float	Data (unsigned int iVertexIndex) const
	Returns the float data value stored in the vertex change. More...

const Vector &	OriginalPosition (unsigned int iVertexIndex) const
	This function returns the position of a vertex before this change. More...

__forceinline Vector	OriginalNormal (unsigned int iVertexIndex) const __attribute__((always_inline))
	This function returns the surface normal before the change for a specified vertex. More...

__forceinline VertexChange &	Add (unsigned int iVertexIndex, unsigned int iFaceIndex, bool bPrecalculateLayerIndex=false, float fDataInitialValue=0.0f) __attribute__((always_inline))
	Register a vertex for the change, and returns the corresponding VertexChange structure. More...

void	Finish (bool bUndo=true, bool bMerge=false)
	This function must be called when no more vertices will be changed within the 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...

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

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

Friends
class	Mesh

class	::XMesh

Additional Inherited Members
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...

Public Attributes inherited from Node
AttributeThisPointer	m_pThis

	DECLARE_CLASS

Member Typedef Documentation

typedef StoredVertexInfo VertexChange

This struct holds the change information about a single vertex.

Definition at line 1481 of file mesh.h.

Member Function Documentation

float Data ( unsigned int iVertexIndex ) const

inline

Returns the float data value stored in the vertex change.

Parameters

[in] iVertexIndex Index of the vertex

Definition at line 1484 of file mesh.h.

     {
         Vertex &v = m_pMesh->VertexData( iVertexIndex );
         if ( v.m_iStrokeID < m_iVertexCount && m_pArray[v.m_iStrokeID].m_iVertexIndex == iVertexIndex )
             return m_pArray[v.m_iStrokeID].m_fData;
         else
             return 0.0f;
     };

const Vector& OriginalPosition ( unsigned int iVertexIndex ) const

inline

This function returns the position of a vertex before this change.

Parameters

[in] iVertexIndex Index of the vertex

Definition at line 1496 of file mesh.h.

     {
         Vertex &v = m_pMesh->VertexData( iVertexIndex );
         if ( v.m_iStrokeID < m_iVertexCount && m_pArray[v.m_iStrokeID].m_iVertexIndex == iVertexIndex )
             return m_pArray[v.m_iStrokeID].m_vPosition;
         else
             return v.m_vPos;
     };

__forceinline Vector OriginalNormal ( unsigned int iVertexIndex ) const

inline

This function returns the surface normal before the change for a specified vertex.

Parameters

[in] iVertexIndex Index of the vertex

Definition at line 1508 of file mesh.h.

     {
         Vertex &v = m_pMesh->VertexData( iVertexIndex );
         if ( v.m_iStrokeID < m_iVertexCount && m_pArray[v.m_iStrokeID].m_iVertexIndex == iVertexIndex )
             return m_pArray[v.m_iStrokeID].m_vNormal;
         else
             //return v.m_vNormal;
             return m_pMesh->VertexNormal(iVertexIndex);
     };

__forceinline VertexChange& Add	(	unsigned int	iVertexIndex,
		unsigned int	iFaceIndex,
		bool	bPrecalculateLayerIndex = `false`,
		float	fDataInitialValue = `0.0f`
	)

inline

Register a vertex for the change, and returns the corresponding VertexChange structure.

This function must be called before modifying the position of a vertex.

Parameters

[in]	iVertexIndex	Index of the vertex
[in]	iFaceIndex	Index of any face which uses the vertex
[in]	bPrecalculateLayerIndex	When this parameter is true, the function will
	fDataInitialValue	precalculate the layer index of the vertex. [in] If the VertexChange has to be created, the initial value of the m_fData bember can be set here.

Definition at line 1534 of file mesh.h.

     {
         Vertex &v = m_pMesh->VertexData( iVertexIndex );
         if ( v.m_iStrokeID < m_iVertexCount && 
              m_pArray[v.m_iStrokeID].m_iVertexIndex == iVertexIndex )
             return m_pArray[v.m_iStrokeID]; // 80% of the time it hits this...
         else {
             return Add_uncached(iVertexIndex, iFaceIndex, v, bPrecalculateLayerIndex, fDataInitialValue );
         }
     };

void Finish	(	bool	bUndo = `true`,
		bool	bMerge = `false`
	)

This function must be called when no more vertices will be changed within the operation.

Parameters

[in]	bUndo	When this parameter is true, the changes made to the vertex positions are automatically stored
	bMerge	in the undo buffer, and becomes undoable [in] If this is true the undo operation is merged into the previous one causing one single undo

Friends And Related Function Documentation

friend class Mesh

friend

Definition at line 1564 of file mesh.h.

friend class ::XMesh

friend

Definition at line 1565 of file mesh.h.

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

Mudbox/mesh.h

MeshChange Class Reference

Class Description

Public Types

Public Member Functions

Friends

Additional Inherited Members

Member Typedef Documentation

Member Function Documentation

Friends And Related Function Documentation