mudbox::Geometry Class Reference

#include <geometry.h>

Inheritance diagram for mudbox::Geometry:

[legend] List of all members.

---

Detailed Description

Represents a 3d object in the scene.

Public Member Functions
virtual const mudbox::ClassDesc *	RuntimeClass (void) const
virtual unsigned int	LevelCount (void) const
	Returns the number of the subdivision levels in the object.
virtual SubdivisionLevel *	LowestLevel (void) const
	Returns a pointer to the lowest subdivision level (the one with the fewest faces).
virtual SubdivisionLevel *	HighestLevel (void) const
	Returns a pointer to the highest subdivision level (the one with the most faces).
virtual SubdivisionLevel *	Level (unsigned int iIndex) const
	Returns a subdivision level by index. Returns NULL if index is out-of-range.
virtual void	AddLevel (SubdivisionLevel *pLevel, bool bFirst=false)
	Adds a subdivision level to the object.
virtual SubdivisionLevel *	ActiveLevel (void) const
	Returns the active subdivision level.
virtual void	SetActiveLevel (SubdivisionLevel *pNewActiveLevel)
	Sets the active subdivision level.
virtual unsigned int	LayerCount () const
	Returns the number of sculpt layers in this geometry.
virtual LayerMeshData *	LayerData (unsigned int iLayer, const SubdivisionLevel *pLevel) const
	Returns a pointer to the layer delta/mask data for the specified layer.
virtual mudbox::Material *	Material (void) const
	Returns the material associated with this geometry.
virtual void	SetMaterial (mudbox::Material *pMaterial)
	Sets the material associated with this geometry.
Static Public Member Functions
const mudbox::ClassDesc *	StaticClass (void)
mudbox::Node *	CreateInstances (unsigned int iCount=1)
Public Attributes
aptr< SubdivisionLevel >	m_pActiveLevel
	This variable contains the address of the active level. Plugins can use this attribute to catch level change events by connecting their own attribute of the same type.
Protected Member Functions
	Geometry (void)
	Constructor. Do not use this directly; use CreateInstance() instead.

---

Constructor & Destructor Documentation

mudbox::Geometry::Geometry (  void   )  [protected]

Constructor. Do not use this directly; use CreateInstance() instead.

---

Member Function Documentation

virtual const mudbox::ClassDesc* mudbox::Geometry::RuntimeClass (  void   )  const [inline, virtual]

Reimplemented from mudbox::GroupNode. :

const mudbox::ClassDesc* mudbox::Geometry::StaticClass (  void   )  [static]

Reimplemented from mudbox::GroupNode.

mudbox::Node* mudbox::Geometry::CreateInstances (  unsigned int  iCount = 1  )  [static]

Reimplemented from mudbox::GroupNode.

virtual unsigned int mudbox::Geometry::LevelCount (  void   )  const [virtual]

Returns the number of the subdivision levels in the object.

virtual SubdivisionLevel* mudbox::Geometry::LowestLevel (  void   )  const [virtual]

Returns a pointer to the lowest subdivision level (the one with the fewest faces).

virtual SubdivisionLevel* mudbox::Geometry::HighestLevel (  void   )  const [virtual]

Returns a pointer to the highest subdivision level (the one with the most faces).

virtual SubdivisionLevel* mudbox::Geometry::Level (  unsigned int  iIndex  )  const [virtual]

Returns a subdivision level by index. Returns NULL if index is out-of-range. Parameters: iIndex  [in] Index of the subdivision level to be returned

virtual void mudbox::Geometry::AddLevel (  SubdivisionLevel *  pLevel, bool  bFirst = false )  [virtual]

Adds a subdivision level to the object. Parameters: pLevel  [in] The subdivision level. bFirst  [in] true to add as the first level. (if there are no levels, this parameter is ignored)

virtual SubdivisionLevel* mudbox::Geometry::ActiveLevel (  void   )  const [virtual]

Returns the active subdivision level.

virtual void mudbox::Geometry::SetActiveLevel (  SubdivisionLevel *  pNewActiveLevel  )  [virtual]

Sets the active subdivision level. Parameters: pNewActiveLevel  [in] A pointer to the subdivision level to be made active.

virtual unsigned int mudbox::Geometry::LayerCount (   )  const [virtual]

Returns the number of sculpt layers in this geometry.

virtual LayerMeshData* mudbox::Geometry::LayerData (  unsigned int  iLayer, const SubdivisionLevel *  pLevel )  const [virtual]

Returns a pointer to the layer delta/mask data for the specified layer. Returns NULL if there is no layer data for the given subdivision level or if the layer index is out of range. Parameters: iLayer  [in] Index to a sculpt layer. pLevel  [in] Pointer to the subdivision level for the layer data.

virtual mudbox::Material* mudbox::Geometry::Material (  void   )  const [virtual]

Returns the material associated with this geometry.

virtual void mudbox::Geometry::SetMaterial (  mudbox::Material *  pMaterial  )  [virtual]

Sets the material associated with this geometry.

---

Member Data Documentation

aptr<SubdivisionLevel> mudbox::Geometry::m_pActiveLevel

This variable contains the address of the active level. Plugins can use this attribute to catch level change events by connecting their own attribute of the same type. See also: Attribute::Connect() Node::OnNodeEvent()

---

mudbox::Geometry mudbox::Geometry mudbox::Geometry mudbox::Geometry mudbox::Geometry mudbox::Geometry mudbox::Geometry mudbox::Geometry mudbox::Geometry mudbox::Geometry

mudbox::Geometry mudbox::Geometry mudbox::Geometry mudbox::Geometry mudbox::Geometry mudbox::Geometry mudbox::Geometry mudbox::Geometry mudbox::Geometry mudbox::Geometry