mudbox Namespace Reference

Detailed Description

This class can implement a general square convolution kernel, or can generate one procedurally.

The procedural Kernel generator implements a 2D gaussian shaped image sharpening (or blurring kernel). The type of sharpening performed is typically called unsharp masking. The filter weights are detemined by the formula:

2 2 2 2 -( ( dx + dy ) / (2 * sigma * radius ) ) e where: dx = x distance from center of kernel dy = y distance from center of kernel

This creates a circularly symmetric, Gaussian shapped kernel. The filter weights are then normalized so their sum = 1.0 and to produce an output that computes:

(1+sharpness)*I - sharpness*G

where I is the original image G is the orignal image with the gausing kernel applied.

Here are some example kernels with the default sharpness factor, 0.5, for various radii:

-0.00002 -0.0006 -0.0020 -0.0006 -0.00002 -0.00006 -0.0053 -0.00006 -0.0006 -0.0189 -0.0581 -0.0189 -0.0006 -0.0053 1.0215 -0.0053 -0.0020 -0.0581 1.3210 -0.0581 -0.0020 -0.00006 -0.0053 -0.00006 -0.0006 -0.0189 -0.0581 -0.0189 -0.0006 -0.00002 -0.0013 -0.0020 -0.0013 -0.00002

Radius = 1 Radius = 2

The default kernel is:

-0.0057 -0.0419 -0.0057 -0.0419 1.1903 -0.0419 -0.0057 -0.0419 -0.0057

The sharpness typically ranges from -1 for maximum blur (makeing a standard gaussian blur), to 0 for no effect, to positive values up to about 10 for various degrees of sharpening. Values greater than 1 create a very pronounced sharpening effect. The radius can be any non-negative value. A radius of zero will perform no filtering, while successively larger values will filter lower and lower frequencies. The actual kernel size is determined by the formula:

width,height = 1 + 2*(int)radius

Thus, a radius of 1.5 (the default) will create a 3x3 kernel.

Typically the parameters you would use for:

Low Sharpen -- Sharpness = 5.0, Radius = 1.5 Medium Sharpen -- Sharpness = 7.5, Radius = 1.75 High Sharpen -- Sharpness = 10.0, Radius = 2.0

For a Sharpen tool, the typical ranges would be 0.0 to 10.0 for Sharpness, and 1.0 to 4.0 for Radius

Blur values would be as follows:

Low Blur -- Sharpness = -1.0, Radius = 3.0 Medium Blur -- Sharpness = -1.0, Radius = 8.0 High Blur -- Sharpness = -1.0, Radius = 32.0

For a blur tool, the Sharpness value would be fixed at -1.0, and the typical range for the user to select radius would be 1.0 to 32.0. The blur kernels generated by this class are seperable.


Classes
class	mudbox::Block
	An internal helper class, representing a block of memory. Use the Store class instead. More...
class	mudbox::Array< type >
	An internal helper class, representing an array. Use the Store class instead. More...
class	mudbox::Store< type >
	Simple array class. More...
struct	mudbox::BrushConfiguration
	This class can be used to define configurations for different brush behaviours of the same class. More...
struct	mudbox::MirrorConfiguration
	The structure contains information about mirroring of the operation. More...
struct	mudbox::StampConfiguration
	Container class for stamp related properties and functions. More...
class	mudbox::BrushOperation
	The BrushOperation class is the base class for brush functionality. More...
struct	mudbox::BrushMask
	This class can be used for masking out areas from the brush effect. More...
struct	mudbox::BrushStamp
	A masking image aligned to a mesh surface. More...
struct	mudbox::BrushStencil
	A masking image attached to a camera. More...
class	mudbox::Camera
	Represents a camera (point of view) in a Mudbox scene. Only one is active at one time. More...
class	mudbox::ConvolutionKernel
class	mudbox::Error
	Holds information about an error. Typically heap allocated. More...
class	mudbox::Geometry
	Represents a 3d object in the scene. More...
class	mudbox::half_
	Half precision (16 bit) float class. Supports fast conversion between float and half precision. More...
class	mudbox::uInt8Channel
	The data type for a 8 bit image channel. More...
class	mudbox::uInt16Channel
	The data type for a 16 bit image channel. 0-65535 maps to 0.0 to 1.0. More...
class	mudbox::float32Channel
class	mudbox::float16Channel
	The data type for a 16 bit float image channel. More...
class	mudbox::PixelType< ChanType, NumChans >
	A templated pixel type class, where the channel type and number of channels are arguments. More...
class	mudbox::ImgTile
	Represents a rectangle. Used to specify rectangular regions of an image. More...
class	mudbox::ImgTile_AoutB_Iter
	Iterates over a the region of tile A that is outside tile B. If tile A is contained inside tile B, this region will be empty. More...
class	mudbox::ImgTileUnion
class	mudbox::ImgPageIterator
	Iterates over a specified region of an image in optimal order. More...
class	mudbox::ImgLockPageIterator
	Iterate over a specified region of an image in optimal order, and locking it in CPU memory. More...
class	mudbox::PixelDescriptor
	Describe an image pixel; how to interpret a piece of pixel data. More...
class	mudbox::ImageDescriptor
	Describe an image, specifically how to interpret pixel data. More...
class	mudbox::Image
	This is the base image type defining the interface to images. More...
class	mudbox::EnvironmentMap
class	mudbox::ImageAccessorBase< ChannelType, nch >
	The ImageAccessorBase class gives you very fast access to pixels when the data type and channel count of an image are known at compile time (and this is very often the case.). More...
class	mudbox::ImageAccessor< ChannelType, nch >
class	mudbox::ImageAccessor< ChannelType, 3 >
class	mudbox::ImageAccessor< ChannelType, 2 >
class	mudbox::ImageAccessor< ChannelType, 1 >
class	mudbox::ImageFilter
	This is the base image filter type defining the interface to image filters (blur, sharpen, dodge, burn, etc). The filters themselves are implemented as plugins. More...
class	mudbox::Importer
	This class is the base class for plugins that import geometry into Mudbox. More...
class	mudbox::Exporter
	This class is the base class for plugins that export mesh geometry from Mudbox. More...
class	mudbox::Interface
class	mudbox::Action
	This class represents an action which can be triggered by the user. More...
class	mudbox::FileEvent
	Holds information about the a recent or in-progress file event. See m_pFileEvent for more information. More...
class	mudbox::KeyboardEvent
class	mudbox::Kernel
	The main API access point to Mudbox, contains the most basic functions and data. More...
class	mudbox::Timer
	Helps finding performance issues. See the MB_TIMER macro for more details. More...
class	mudbox::Statistics
	Holds useful information about the current session of Mudbox. More...
class	mudbox::Instance< c >
	This is a helper class to manage class instances implemented in plugins, provided for convenience. More...
class	mudbox::Layer
	This is the base class for anything which is an element of a list with a fixed order and a transparency value assigned to each element. More...
class	mudbox::LayerContainer
	This class contains and manages a list of Layers. More...
class	mudbox::LayerMeshData
	This class represents a Sculpt Layer. More...
class	mudbox::Light
	Represents a light source in the scene. More...
class	mudbox::Material
	Describes a material of a geometry including its surface colors, transparency and texture information. More...
class	mudbox::TextureMixer
	Represents a texture mixer. More...
class	mudbox::TexturePool
	This is a container class for simple textures. More...
class	mudbox::Texture
	Represents a texture tile inside a texture pool. More...
class	mudbox::RenderTarget
	RenderTarget is an abstraction of an OpenGL renderbuffer object. More...
class	mudbox::Vector
	Represents a 3D vector or point with S23E8 floating point elements. More...
class	mudbox::Vector4
	A four dimensionsional vector (X, Y, Z, and W). More...
class	mudbox::Color
	Represents a color with four components: red, green, blue, alpha. More...
class	mudbox::AxisAlignedBoundingBox
	Represents a bounding box whose axes are aligned with the coordinate system. More...
class	mudbox::Base
	Represents a local coordinate basis comprising three axes that define a coordinate system. More...
class	mudbox::SubSpace
	This class will be removed from the SDK. More...
class	mudbox::Matrix
	This class represents a 4x4 transformation matrix. More...
class	mudbox::Quaternion
	The Quaternion class is used to represent rotations in most cases. More...
class	mudbox::DualQuaternion
	The DualQuaternion class is used to represent rigid transformations in most cases. More...
class	mudbox::Line
	Represents a line segment in 3d space. More...
class	mudbox::Selector
	Mudbox uses this class to provide information about specific regions in the space. More...
class	mudbox::CheckableFloat
	A container class that holds a boolean and a float value. More...
class	mudbox::AttributeCheckableFloat
struct	mudbox::Vertex
	A Vertex has an x,y,z position in space, a normal, a "Freeze" value between 0.0 and 1.0, and a boolean flag saying whether or not the vertex is currently selected. More...
struct	mudbox::TC
	A Mesh object may or may not have Texture Coordinates. More...
class	mudbox::FaceEnumerator
	FaceEnumerator is a base class for operations that must be applied across mesh faces. More...
class	mudbox::VertexEnumerator
	To use this class, derive a new enumerator from it. More...
class	mudbox::AdjacentVertexEnumerator
	AdjacentVertexEnumerator is a base class for operations that must be applied to all vertices adjacent to a specified one. More...
class	mudbox::Mesh
	A Mesh is a collection of vertices organized into faces, and optional Texture Coordinate information. More...
class	mudbox::TangentGenerator
	TangentGenerator is a class that defines the tangent space used by Mesh objects. More...
struct	mudbox::SurfacePoint
	SurfacePoint objects are generally returned by Picker objects, who have interpreted a user action that involves selecting a point on the mesh. More...
class	mudbox::Picker
	Picker objects are used as part of the map extraction process, to find points on one mesh that most closely correspond to points on another. This is used for creating displacement maps, normal maps, color maps, etc. More...
class	mudbox::ScreenSpacePicker
	ScreenSpacePicker objects are used to translate the user action of clicking in the view into a picked point on the surface of a mesh. More...
class	mudbox::MeshGrid
	The MeshGrid class is an interface for dividing the surface of a mesh to grids. More...
class	mudbox::SurfaceSmoother
	This is an interface for a SurfaceSmoother object, which is responsible to provide information about the limit surface of a mesh. More...
class	mudbox::MeshChange
	This class represents a change to a mesh, and is used when an operation which modifies mesh vertices should be undoable. More...
struct	mudbox::MeshChange::VertexChange
	This struct holds the change information about a single vertex. More...
class	mudbox::MeshUnlocker
	This object is used to manage the lock on a mesh. More...
class	mudbox::ClassDesc
	This structure represents and describes a class. More...
struct	mudbox::Attribute
	This is an abstract base structure for all attributes. Do not use it directly, use AttributeInstance instead. More...
class	mudbox::AttributeVoid
	Used to insert expanded category item. More...
struct	mudbox::AttributeInstance< type >
	This is a generic attribute which can be used instead of the standard built in types. More...
class	mudbox::AttributePointer< type >
	This class can be used instead of standard pointers, when the pointer target class is derived from the Node class. More...
class	mudbox::AttributeThisPointer
	This class represents a special pointer in the Node class, it always points to the owner. Used internally. More...
class	mudbox::Node
	This is the base class for most classes in the Mudbox SDK. More...
class	mudbox::EventGate
	This class represents an event receiver/triggerer point. More...
class	mudbox::AttributeFloatRange
	This attribute represents a float value which has a minimum and a maximum value. These values will be used in the user interface only, but the user will be able to assign values out of the range to the attribute. More...
class	mudbox::AttributeNumber
	An attribute that can hold a number and uses the specified number of digits when displaying on the UI. More...
class	mudbox::AttributeEnumeration
	This attribute is very similar to the aint type but on the user interface it will be displayed as a combobox, and the user will be able to choose its value from a list. More...
class	mudbox::AttributeFilename
	Similar to AttributeInstance<String> but it provides a button on the interface where the user can browse for a filename. More...
class	mudbox::AttributeTextureFilename
	Represents a special file name attribute that accepts texture files as value. Provides a create new and a browse interface. More...
class	mudbox::AttributeWatch
	A fake attribute used to watch an attribute in your class which is not a member. Its better if you create a copy of the attribute in your class with the same type and link it to the target, but if you do not know the exact type of the other attribute you can use this class. More...
class	mudbox::AttributeBoolCollection
	This attribute is a collection of bools. More...
class	mudbox::NURBSCurve
struct	mudbox::NURBSCurve::ChordLength
class	mudbox::NURBSCurveEditor
class	mudbox::AttributeCurvePointer
class	mudbox::Operation
	The base class of all operations. More...
struct	mudbox::Plugin
	This class holds all the information Mudbox needs about a plugin. More...
class	mudbox::WindowPlugin
	WindowPlugin is an interface to implement window based plugins. More...
class	mudbox::WebBrowserPlugin
	WebBrowserPlugin is a base class to implement the web browser based plugins. More...
class	mudbox::Preferences
	Holds Mudbox application preferences. Most of the data members will be removed from the SDK in future releases. For more information about adding an item to preferences see Preferences::Integer. More...
class	mudbox::Preferences::Integer
	This class holds a simple integer preference. More...
class	mudbox::Preferences::Bool
	This class is a simple boolean preference, appears as a checkbox. See Preferences::Integer for details. More...
class	mudbox::Preferences::Float
	This class represents a float value, appears as an editbox and a slider. See Preferences::Integer for mode details. More...
class	mudbox::Preferences::String
	This class represents a string preference value. See Preferences::Integer for mode details. More...
class	mudbox::Preferences::Color
	This class represents a color item in the preferences. See Preferences::Integer for mode details. More...
class	mudbox::Preferences::Vector
	This class represents a 3d vector item. See Preferences::Integer for mode details. More...
class	mudbox::Preferences::Enum
	This class represents a enum item, appears as a combo box. See Preferences::Enum for mode details. More...
class	mudbox::MeshRenderer
	This is the base class for a renderer implementation, which transforms a mesh into the opengl pipeline. More...
class	mudbox::VertexDataProvider
	This interface can be used to provide additional vertex data for the rendering. More...
struct	mudbox::VertexDataProvider::ComponentDescription
	This structure carries information about a component. More...
struct	mudbox::VertexDataProvider::DirtyVertex
	This structure describes a dirty vertex. More...
class	mudbox::Scene
	The Scene class is the container object for all the data in a Mudbox scene. More...
class	mudbox::SelectionSet
	This class represents a collection of faces among one or more mesh objects. More...
struct	mudbox::SelectionSet::MeshInfo
	This structure holds the collection of faces for a given mesh. More...
class	mudbox::Stream
	Streams are used to read information from a file, or to write it to a file. More...
class	mudbox::SubdivisionLevel
	Represents one level of subdivision details in a geometry. More...
struct	mudbox::Normal
	Normal vector with 16 bit components. More...
class	mudbox::Topology
	The class Mesh is inherited from this class, and provides information about the vertices. More...
class	mudbox::GroupNode
	This is the base class for all nodes that are transformable objects in the Mudbox scene. More...
class	mudbox::Transformation
	A Transformation is a node in the Mudbox scene that controls the size and position of other nodes, such as lights, cameras, or polygon meshes. More...
class	mudbox::TransformationPalette
	This object provides additional transformations for a mesh (skinning). More...
class	mudbox::TrayAccessor
	TrayAccessor allows plugins to access the trays in the GUI. More...
class	mudbox::TreeNode
	This class is the base of all node types that can be structured in a hierarchy. More...
struct	mudbox::ViewPortState
	Holds all the information about the current viewport state, used by ViewPortFilter objects. More...
class	mudbox::ViewPortFilter
	ViewPortFilters are post-processes that are applied to the rendered scene before display. More...
class	mudbox::ViewPort
	Represents the 3D viewport where Mudbox renders the scene. More...
class	mudbox::AttributeSign
class	mudbox::AttributeWidget
class	mudbox::AttributeVectorbox
class	mudbox::AttributeVector4box
	A widget used to display and alter the value for a four dimensional vector attribute. More...
class	mudbox::AttributeEditbox
class	mudbox::AttributeImagebox
	A widget used to display and alter the value for an image attribute. More...
class	mudbox::AttributeCheckbox
	A widget which is used to display and alter the value for a bool attribute. More...
class	mudbox::AttributeColorbox
class	mudbox::AttributeSliderbox
	A widget which used to display and alter the value for a float range attribute. More...
class	mudbox::AttributeSliderbox::Slider
class	mudbox::AttributeSpinbox
struct	mudbox::AttributeSpinbox::SpinBox
class	mudbox::AttributeCombobox
	A widget used to display and alter the value for an enum attribute. More...
class	mudbox::AttributeFilenamebox
	A widget used to display and alter the value for a filename attribute. More...
class	mudbox::AttributeTextureFilenamebox
	A widget which is used to display and alter the value for a texture attribu. More...
class	mudbox::AttributeEventbox
class	mudbox::AttributePointerbox
	A widget used to display and alter the value for a pointer attribute. More...
class	mudbox::AttributeCheckboxCollection
	A widget used to display and alter the value for a bool collection attribute. More...
class	mudbox::AttributeSliderWithCheckbox
	A widget which is used to display and alter the value for a bool attribute. More...
class	mudbox::CPBox
class	mudbox::CurveEditor
class	mudbox::AttributeCurveEditor
class	mudbox::AttributeStampConfigurationWidget
class	mudbox::MirrorComboBox
	MirrorComboBox is a QComboBox that emits a signal when it loses keyboard focus. More...
class	mudbox::AttributeMirrorConfigurationWidget
	An attribute widget for setting the brush mirror mode. More...
Typedefs
typedef AttributeInstance< MirrorConfiguration >	amirrorcfg
typedef AttributeInstance< StampConfiguration >	astampcfg
typedef unsigned char	uInt8
typedef unsigned short	uInt16
typedef AttributeInstance< Vector >	avector
typedef AttributeInstance< Vector4 >	avector4
typedef AttributeInstance< Color >	acolor
typedef AttributeCheckableFloat	acheckablefloat
typedef long long	int64
typedef unsigned long long	uint64
typedef AttributeVoid	avoid
typedef AttributeInstance< int >	aint
	This type has to be used instead of the general int type.
typedef AttributeInstance< float >	afloat
	This type has to be used instead of the general float type.
typedef AttributeInstance< bool >	abool
	This type has to be used instead of the general bool type.
typedef AttributeInstance< QString >	astring
	This type has to be used instead of the String type.
typedef EventGate	aevent
typedef AttributeFloatRange	afloatr
typedef AttributeNumber	anumber
typedef AttributeEnumeration	aenum
typedef AttributeFilename	afilename
typedef AttributeTextureFilename	atexturefilename
typedef AttributeBoolCollection	aboolc
typedef AttributeCurvePointer	acurveptr
typedef Node *	NodePointer
typedef short int	tnormal
	Type of one component in a normal vector.
typedef unsigned long long	tnormalv
	Type of the whole normal vector.
Enumerations
enum	MirrorMode { eMirrorNone, eMirrorX, eMirrorY, eMirrorZ, eMirrorLocalX, eMirrorLocalY, eMirrorLocalZ, eMirrorTangent }
	Possible values for the brush mirror attribute. MirrorConfiguration. More...
enum	NodeEventType { etValueChanged, etSourceChanged, etTargetChanged, etPointerContentChanged, etPointerTargetDestroyed, etStatusChanged, etPointerTargetUIChanged, etDeferred, etRefreshDialogUI, etEventTriggered = etValueChanged }
	Possible event types when Node::OnNodeEvent is called. More...
enum	LinearUnits { eMillimeter, eCentimeter, eMeter, eInch }
enum	SelectionMode { ePaint = 0, eRectangle, eLasso }
enum	InactiveLevelDisplay { eNone, eHide, eShade }
Functions
void MBDLL_DECL	QuickSort (void pBase, unsigned int iNum, unsigned int iSize, int(fComparator)(const void , const void ))
MBDLL_DECL AttributeWidget *	CreateNewMirrorConfigurationWidget (QWidget pParent, int iWidth, amirrorcfg pAttribute)
MBDLL_DECL AttributeWidget *	CreateNewStampConfigurationWidget (QWidget pParent, int iWidth, astampcfg pAttribute)
MBDLL_DECL AttributeWidget *	CreateNewImageWidget (QWidget pParent, int iWidth, AttributePointer< Image > pImage)
MBDLL_DECL Kernel *	Kernel (void)
	Returns a pointer to the mudbox kernel object.
template<typename c>
c *	CreateInstance (void)
	This function provides an easy way to create objects based on interfaces.
MBDLL_DECL Vector	operator * (float f, const Vector &v) throw ()
	Multiplies a float scalar value by a vector, the result is a vector.
MBDLL_DECL Vector	operator * (int i, const Vector &v) throw ()
	Multiplies an integer scalar value by a vector, the result is a vector.
MBDLL_DECL AttributeWidget *	CreateNewVectorWidget (QWidget pParent, int iWidth, avector pAttribute)
MBDLL_DECL AttributeWidget *	CreateNewVector4Widget (QWidget pParent, int iWidth, avector4 pAttribute)
Color	operator * (float f, const Color &c)
	Multiplies a scalar float value by a Color.
MBDLL_DECL AttributeWidget *	CreateNewColorWidget (QWidget pParent, int iWidth, acolor pAttribute)
MBDLL_DECL Vector	operator * (const Vector &v, const Matrix &m)
MBDLL_DECL Vector	operator * (const Matrix &m, const Vector &v)
MBDLL_DECL AttributeWidget *	CreateNewCheckableFloatWidget (QWidget pParent, int iWidth, class AttributeCheckableFloat pAttribute)
template<typename type>
type	Min (type a, type b)
template<typename type>
type	Max (type a, type b)
bool MBDLL_DECL	AssertFailed (const char sSourceFile, int iSourceLine, const char sCondition, const char *sMessage)
float MBDLL_DECL	Modf (float value)
MBDLL_DECL AttributeWidget *	CreateNewPtrWidget (QWidget pParent, int iWidth, Attribute pAttribute, const ClassDesc *pType)
MBDLL_DECL AttributeWidget *	CreateNewBoolWidget (QWidget pParent, int iWidth, abool pAttribute)
MBDLL_DECL AttributeWidget *	CreateNewIntWidget (QWidget pParent, int iWidth, aint pAttribute)
template<typename type>
bool	operator== (const Attribute &cA, const AttributeInstance< type > &cB)
	This operator compares the two attributes and NOT their values. Returns true only if the two attribute instances are the same (See Node::OnNodeEvent).
template<typename type>
Stream &	operator== (Stream &s, AttributeInstance< type > &c)
template<typename type>
Stream &	operator== (Stream &cStream, AttributePointer< type > &cPointer)
AttributeWidget *	CreateNewEventWidget (QWidget pParent, int iWidth, EventGate pAttribute)
	Creates an event widget.
MBDLL_DECL Stream &	operator== (Stream &s, afloatr &a)
MBDLL_DECL Stream &	operator== (Stream &s, aenum &a)
MBDLL_DECL Stream &	operator== (Stream &s, afilename &a)
MBDLL_DECL AttributeWidget *	CreateNewCurveWidget (QWidget pParent, int iWidth, Attribute pAttribute)
template<typename type>
Stream &	operator== (Stream &s, type &v)
	Serializes any data type to/from the stream.
template<typename type>
Stream &	operator== (Stream &s, const type &v)

Typedef Documentation

typedef AttributeInstance<MirrorConfiguration> mudbox::amirrorcfg

typedef AttributeInstance<StampConfiguration> mudbox::astampcfg

typedef unsigned char mudbox::uInt8

typedef unsigned short mudbox::uInt16

typedef AttributeInstance<Vector> mudbox::avector

typedef AttributeInstance<Vector4> mudbox::avector4

typedef AttributeInstance<Color> mudbox::acolor

typedef AttributeCheckableFloat mudbox::acheckablefloat

typedef long long mudbox::int64

typedef unsigned long long mudbox::uint64

typedef AttributeVoid mudbox::avoid

typedef AttributeInstance<int> mudbox::aint

This type has to be used instead of the general int type.

typedef AttributeInstance<float> mudbox::afloat

This type has to be used instead of the general float type.

typedef AttributeInstance<bool> mudbox::abool

This type has to be used instead of the general bool type.

typedef AttributeInstance<QString> mudbox::astring

This type has to be used instead of the String type.

typedef EventGate mudbox::aevent

typedef AttributeFloatRange mudbox::afloatr

typedef AttributeNumber mudbox::anumber

typedef AttributeEnumeration mudbox::aenum

typedef AttributeFilename mudbox::afilename

typedef AttributeTextureFilename mudbox::atexturefilename

typedef AttributeBoolCollection mudbox::aboolc

typedef AttributeCurvePointer mudbox::acurveptr

typedef Node* mudbox::NodePointer

typedef short int mudbox::tnormal

Type of one component in a normal vector.

typedef unsigned long long mudbox::tnormalv

Type of the whole normal vector.

Enumeration Type Documentation

enum MirrorMode

Possible values for the brush mirror attribute. MirrorConfiguration.

Enumeration values:

eMirrorNone	No mirror.
eMirrorX	Mirror on global X axis.
eMirrorY	Mirror on global Y axis.
eMirrorZ	Mirror on global Z axis.
eMirrorLocalX	Mirror on local X axis.
eMirrorLocalY	Mirror on local Y axis.
eMirrorLocalZ	Mirror on local Z axis.
eMirrorTangent	Mirror using topology symmmetry.

00052 {
00054     eMirrorNone,
00056     eMirrorX,
00058     eMirrorY,
00060     eMirrorZ,
00062     eMirrorLocalX,
00064     eMirrorLocalY,
00066     eMirrorLocalZ,
00068     eMirrorTangent
00069 };

enum NodeEventType

Possible event types when Node::OnNodeEvent is called.

Enumeration values:

etValueChanged	Value of an attribute is changed.
etSourceChanged	The attribute is relinked to another attribute, so source is changed.
etTargetChanged	A new attribute is linked to this one, or a link is removed.
etPointerContentChanged	This is valid only for pointer type attributes (See AttributePointer). This is posted when the target node of the pointer is changed (See Node::ContentChanged()).
etPointerTargetDestroyed	This is valid only for pointer type attributes (See AttributePointer). The target node of the pointer is about to destroyed.
etStatusChanged	Status of the attribute is changed (See SetConst()).
etPointerTargetUIChanged	UI data in attributes are changed.
etDeferred	Previously requested deferred event.
etRefreshDialogUI	Causes entire dialog to refresh its UI. Should be used at the end of a batch job.
etEventTriggered	An event triggered.

00140 {
00142     etValueChanged,
00144     etSourceChanged,
00146     etTargetChanged,
00148     etPointerContentChanged,
00150     etPointerTargetDestroyed,
00152     etStatusChanged,
00154     etPointerTargetUIChanged,
00156     etDeferred,
00159     etRefreshDialogUI,
00161     etEventTriggered = etValueChanged
00162 };

enum LinearUnits

Enumeration values:

eMillimeter
eCentimeter
eMeter
eInch

00026 {
00027     eMillimeter,
00028     eCentimeter,
00029     eMeter,
00030     eInch
00031 };

enum SelectionMode

Enumeration values:

ePaint
eRectangle
eLasso

00034 {
00035     ePaint = 0,
00036     eRectangle,
00037     eLasso
00038 };

enum InactiveLevelDisplay

Enumeration values:

eNone
eHide
eShade

00041 {
00042     eNone,
00043     eHide,
00044     eShade
00045 };

Function Documentation

void MBDLL_DECL QuickSort	(	void *	pBase,
		unsigned int	iNum,
		unsigned int	iSize,
		int()(const void , const void *)	fComparator
	)

MBDLL_DECL AttributeWidget* CreateNewMirrorConfigurationWidget	(	QWidget *	pParent,
		int	iWidth,
		amirrorcfg *	pAttribute
	)

MBDLL_DECL AttributeWidget* CreateNewStampConfigurationWidget	(	QWidget *	pParent,
		int	iWidth,
		astampcfg *	pAttribute
	)

MBDLL_DECL AttributeWidget* CreateNewImageWidget	(	QWidget *	pParent,
		int	iWidth,
		AttributePointer< Image > *	pImage
	)

MBDLL_DECL Kernel* Kernel

(

void

)

Returns a pointer to the mudbox kernel object.

template<typename c>
c* CreateInstance	(	void		)

This function provides an easy way to create objects based on interfaces.

Example:

    Image *pMyImage = CreateInstance<Image>();

See Kernel::PreferredDescendant() funtion for more details.

00637 { return dynamic_cast<c *>( Kernel()->CreateClassInstance( c::StaticClass() ) ); };

MBDLL_DECL Vector operator *	(	float	f,
		const Vector &	v
	)	throw () `[inline]`

Multiplies a float scalar value by a vector, the result is a vector.

00306 { return v*f; };

MBDLL_DECL Vector operator *	(	int	i,
		const Vector &	v
	)	throw () `[inline]`

Multiplies an integer scalar value by a vector, the result is a vector.

00310 { return float(i)*v; };

MBDLL_DECL AttributeWidget* CreateNewVectorWidget	(	QWidget *	pParent,
		int	iWidth,
		avector *	pAttribute
	)

MBDLL_DECL AttributeWidget* CreateNewVector4Widget	(	QWidget *	pParent,
		int	iWidth,
		avector4 *	pAttribute
	)

Color operator *	(	float	f,
		const Color &	c
	)	`[inline]`

Multiplies a scalar float value by a Color.

00497 { return Color( c.r*f, c.g*f, c.b*f, c.a*f ); };

MBDLL_DECL AttributeWidget* CreateNewColorWidget	(	QWidget *	pParent,
		int	iWidth,
		acolor *	pAttribute
	)

MBDLL_DECL Vector operator *	(	const Vector &	v,
		const Matrix &	m
	)	`[inline]`

01230 {
01231     return Vector( 
01232         v.m_fX*m._11+v.m_fY*m._21+v.m_fZ*m._31+m._41,
01233         v.m_fX*m._12+v.m_fY*m._22+v.m_fZ*m._32+m._42,
01234         v.m_fX*m._13+v.m_fY*m._23+v.m_fZ*m._33+m._43 );
01235 };

MBDLL_DECL Vector operator *	(	const Matrix &	m,
		const Vector &	v
	)	`[inline]`

01238 {
01239     return Vector( 
01240         v.m_fX*m._11+v.m_fY*m._12+v.m_fZ*m._13+m._14,
01241         v.m_fX*m._21+v.m_fY*m._22+v.m_fZ*m._23+m._24,
01242         v.m_fX*m._31+v.m_fY*m._32+v.m_fZ*m._33+m._34 );
01243 };

MBDLL_DECL AttributeWidget* CreateNewCheckableFloatWidget	(	QWidget *	pParent,
		int	iWidth,
		class AttributeCheckableFloat *	pAttribute
	)

template<typename type>
type Min	(	type	a,
		type	b
	)	`[inline]`

00175 { return a < b ? a : b; };

template<typename type>
type Max	(	type	a,
		type	b
	)	`[inline]`

00177 { return a > b ? a : b; };

bool MBDLL_DECL AssertFailed	(	const char *	sSourceFile,
		int	iSourceLine,
		const char *	sCondition,
		const char *	sMessage
	)

float MBDLL_DECL Modf

(

float

value

)

MBDLL_DECL AttributeWidget* CreateNewPtrWidget	(	QWidget *	pParent,
		int	iWidth,
		Attribute *	pAttribute,
		const ClassDesc *	pType
	)

MBDLL_DECL AttributeWidget* CreateNewBoolWidget	(	QWidget *	pParent,
		int	iWidth,
		abool *	pAttribute
	)

MBDLL_DECL AttributeWidget* CreateNewIntWidget	(	QWidget *	pParent,
		int	iWidth,
		aint *	pAttribute
	)

template<typename type>
bool operator==	(	const Attribute &	cA,
		const AttributeInstance< type > &	cB
	)	`[inline]`

This operator compares the two attributes and NOT their values. Returns true only if the two attribute instances are the same (See Node::OnNodeEvent).

00520                                                                         { return CreateNewIntWidget( pParent, iWidth, this ); };
00521 
00523 template < typename type > inline

template<typename type>
Stream& operator==	(	Stream &	s,
		AttributeInstance< type > &	c
	)	`[inline]`

00531 {

template<typename type>
Stream& operator==	(	Stream &	cStream,
		AttributePointer< type > &	cPointer
	)	`[inline]`

00657 { cPointer.AttributePointer<type>::Serialize( cStream ); return cStream; };

AttributeWidget* CreateNewEventWidget	(	QWidget *	pParent,
		int	iWidth,
		EventGate *	pAttribute
	)

Creates an event widget.

MBDLL_DECL Stream& operator==	(	Stream &	s,
		afloatr &	a
	)

MBDLL_DECL Stream& operator==	(	Stream &	s,
		aenum &	a
	)

MBDLL_DECL Stream& operator==	(	Stream &	s,
		afilename &	a
	)

MBDLL_DECL AttributeWidget* CreateNewCurveWidget	(	QWidget *	pParent,
		int	iWidth,
		Attribute *	pAttribute
	)

template<typename type>
Stream& operator==	(	Stream &	s,
		type &	v
	)	`[inline]`

Serializes any data type to/from the stream.

00283 { if ( s.IsStoring() ) s << v; else s >> v; return s; };

template<typename type>
Stream& operator==	(	Stream &	s,
		const type &	v
	)	`[inline]`

00286 { if ( s.IsStoring() ) s << v; else s >> *((type*)&v); return s; };

mudbox Namespace Reference

Detailed Description

Classes

Typedefs

Enumerations

Functions

Typedef Documentation

Enumeration Type Documentation

Function Documentation