mudbox::Preferences Class Reference

#include <preferences.h>

Inheritance diagram for mudbox::Preferences:

[legend] List of all members.

---

Detailed Description

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.

Public Member Functions
virtual const mudbox::ClassDesc *	RuntimeClass (void) const
	Preferences (void)
	~Preferences (void)
void	Serialize (Stream &)
void	ProcessLine (QString &sSrc, QString &sName, QString &sValue)
void	SavePaths (void)
bool	LoadPaths (void)
QString	FindSettings (QString &sDir)
Attribute *	RegisterVariable (const QString &sName, const QString &sCategory, Attribute::AttributeType eType, const QString &sDefaultValue)
afloatr *	RegisterFloatVariable (const QString &sName, const QString &sCategory, float fDefaultValue)
abool *	RegisterBoolVariable (const QString &sName, const QString &sCategory, bool bDefaultValue)
astring *	RegisterStringVariable (const QString &sName, const QString &sCategory, const QString &sDefaultValue)
acolor *	RegisterColorVariable (const QString &sName, const QString &sCategory, const mudbox::Color &cDefaultValue)
aint *	RegisterIntegerVariable (const QString &sName, const QString &sCategory, int iDefaultValue)
avector *	RegisterVectorVariable (const QString &sName, const QString &sCategory, const mudbox::Vector &vDefaultValue)
aenum *	RegisterEnumVariable (const QString &sName, const QString &sCategory, int iDefaultValue)
void	OnNodeEvent (const Attribute &, NodeEventType)
Static Public Member Functions
const mudbox::ClassDesc *	StaticClass (void)
mudbox::Node *	CreateInstances (unsigned int iCount=1)
Public Attributes
abool	m_bCheckFrustum
abool	m_bMultiThreadRender
abool	m_bHighlightBrushArea
aint	m_iFastBrushLevel
abool	m_bFocusWhenEmpty
abool	m_bFocusWhenNotEmpty
abool	m_bZoomWhileFocus
abool	m_bPickBothSide
abool	m_bUseVideoMemory
abool	m_bRemoveLevels
abool	m_bRemoveOctree
abool	m_bCreateUVs
abool	m_bSmoothUV
abool	m_bSmoothPos
aenum	m_eDefaultMaterial
abool	m_bDisableLODChange
abool	m_bNoPaintUndo
aint	m_fMinPenPressure
aint	m_fMaxPenPressure
aint	m_iGridSize
aint	m_iGridSteps
aint	m_iDoubleClickTime
abool	m_bWireOnShaded
abool	m_bShowPickedFace
aint	m_iWireLevel
aenum	m_eImportAutofocus
bool	m_bFlatLighting
bool	m_bFacetedShading
bool	m_bLighting
afloatr	m_fCameraDollySensitivity
afloatr	m_fCameraTrackSensitivity
afloatr	m_fCameraRotateSensitivity
abool	m_bOptimizeMeshes
abool	m_bShowLayerMask
abool	m_bUseDraftRender
abool	m_bShowFrozenVertices
aint	m_iPointRenderRarity
aint	m_iDraftRenderMinFaceCount
abool	m_bHUDProjectedSubdiv
abool	m_bHUDSelected
abool	m_bHUDVisible
abool	m_bHUDFPS
abool	m_bHUDRendered
aint	m_iHUDProjectedXSubdivisionLevel
aint	m_iMinutesToAlarm
aint	m_iBuildUpRate
afloatr	m_fPressureTreshold
afloatr	m_fStencilRotateSensitivity
abool	m_bForceVidmemRender
abool	m_bUseLocalYForCameraRotation
aenum	m_iCameraControlMode
afloatr	m_fRollArea
aint	m_iMaximumTextureSize
abool	m_bSaveIndicator
abool	m_bSelectPicked
abool	m_bLocalFocus
aint	m_iMirrorPlanes
Store< mudbox::Vector >	m_aMirrorPlaneNormals
Store< mudbox::Vector >	m_aMirrorPlanePositions
abool	m_bMirrorLocal
afloatr	m_fSmartFocus
acolor	m_cViewportCenter
acolor	m_cViewportTop
acolor	m_cViewportBottom
acolor	m_cViewportFlat
acolor	m_cGrid
acolor	m_cGridAxis
acolor	m_cLocked
acolor	m_cSelection
acolor	m_cMask
acolor	m_cActiveLayer
acolor	m_cInactiveLayer
acolor	m_cLayerMask
acolor	m_cSceneInfoBg
acolor	m_cFalloffCurve
acolor	m_cFalloffHull
acolor	m_cFalloffFill
aenum	m_eUnitLinear
aenum	m_eFaceSelectionMode
aenum	m_eObjectSelectionMode
float	m_aLinearUnitRates [4]
astring	m_sDefaultObjDir
astring	m_sDefaultMudDir
astring	m_sDefaultStampDir
astring	m_sDefaultStencilDir
astring	m_sDefaultIconDir
astring	m_sDefaultImagePlaneDir
astring	m_sDefaultTextureLayerDir
astring	m_sDefaultPSDDir
astring	m_sDefaultSaveScreenDir
astring	m_sUserName
astring	m_sLogPath
astring	m_sTempPath
astring	m_sSettingsPath
astring	m_sDataPath
astring	m_sTexturePath
astring	m_sMayaInstallPath
abool	m_bPathsChanged
abool	m_bExpertHidesSouth
abool	m_bExpertHidesEast
abool	m_bExpertHidesMenu
abool	m_bExpertHidesStatus
aint	m_iDragBoxSize
abool	m_bShowLearningMovies
abool	m_bShowWelcomeDialog
abool	m_bHUDInfoMessage
abool	m_bHUDHelpMessage
aenum	m_iHelpType
astring	m_sHelpLocation
abool	m_bCompressFiles
abool	m_bOBJThumbnail
abool	m_bMUDContainsView
abool	m_bMUDContainsBrush
abool	m_bCull
abool	m_bCreateBackup
abool	m_bShowTileInfo
aint	m_iMapWidth
aint	m_iMapHeight
astring	m_sOutputDir
abool	m_bExtractNormal
abool	m_bExtractDisplacement
abool	m_bSmoothNormals
aint	m_iSmoothLevel
aint	m_iNormalSpace
afloat	m_fRayTravel
aint	m_eRayCenter
abool	m_bPickBothSides
aint	m_iEdgeBleed
aint	m_iNormalFormat
aint	m_iDisplacementFormat
aint	m_iSubdivLow
astring	m_sNormalFileName
astring	m_sDisplacementFileName
abool	m_bSkipEmptyMaps
aint	m_iExtUDim
aint	m_iUStart
abool	m_bSelectedFacesOnly
astring	m_sLowObjectName
astring	m_sHighObjectName
abool	m_bInvertTangent
abool	m_bInvertBinormal
afloat	m_fAreaTreshold
astring	m_sTileRange
afloat	m_fMiddleValue
aint	m_iFirstTileIndex
aint	m_iDispUDim
aint	m_iMaskChannel
aint	m_iNegativeDisplacementChannel
aint	m_iPositiveDisplacementChannel
aint	m_iXSubdivisionLevel
astring	m_sObjectName
astring	m_sDisplacementFileMask
astring	m_sMaskFileMask
aenum	m_eTextureRatio
afloat	m_fTextureRatio
avoid	m_lExpertModeLabel
abool	m_bMultisampling
astring	m_sNextCommand
Store< Attribute * >	m_aPluginAttributes
afloatr	m_fPaintBleedDistance
	Specifies a distance how far the edge bleeding should go over UV edges during painting.
afloatr	m_fPaintBrushOffset
abool	m_bFastDryBrush
astring	m_sExportFilter
abool	m_bHideEULANag
aint	m_movieWidth
	movie-recording preferences
aint	m_movieHeight
aint	m_movieRecordFps
aint	m_moviePlaybackFps
abool	m_moviePauseWhenIdle
abool	m_movieUses3dView

---

Constructor & Destructor Documentation

mudbox::Preferences::Preferences (  void   )

mudbox::Preferences::~Preferences (  void   )

---

Member Function Documentation

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

Reimplemented from mudbox::Node. 00053 : Preferences( void );

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

Reimplemented from mudbox::Node.

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

Reimplemented from mudbox::Node.

void mudbox::Preferences::Serialize (  Stream &   )  [virtual]

Reimplemented from mudbox::Node.

void mudbox::Preferences::ProcessLine (  QString &  sSrc, QString &  sName, QString &  sValue )

void mudbox::Preferences::SavePaths (  void   )

bool mudbox::Preferences::LoadPaths (  void   )

QString mudbox::Preferences::FindSettings (  QString &  sDir  )

Attribute* mudbox::Preferences::RegisterVariable (  const QString &  sName, const QString &  sCategory, Attribute::AttributeType  eType, const QString &  sDefaultValue )

afloatr* mudbox::Preferences::RegisterFloatVariable (  const QString &  sName, const QString &  sCategory, float  fDefaultValue )  [inline]

{ return (afloatr *)RegisterVariable( sName, sCategory, Attribute::typeFloat, QString("%1").arg(fDefaultValue) ); };

abool* mudbox::Preferences::RegisterBoolVariable (  const QString &  sName, const QString &  sCategory, bool  bDefaultValue )  [inline]

{ return (abool *)RegisterVariable( sName, sCategory, Attribute::typeBool, bDefaultValue ? "true" : "false" ); };

astring* mudbox::Preferences::RegisterStringVariable (  const QString &  sName, const QString &  sCategory, const QString &  sDefaultValue )  [inline]

{ return (astring *)RegisterVariable( sName, sCategory, Attribute::typeString, sDefaultValue ); };

acolor* mudbox::Preferences::RegisterColorVariable (  const QString &  sName, const QString &  sCategory, const mudbox::Color &  cDefaultValue )  [inline]

{ return (acolor *)RegisterVariable( sName, sCategory, Attribute::typeColor, QString("%1 %2 %3 %4").arg(cDefaultValue.r).arg(cDefaultValue.g).arg(cDefaultValue.b).arg(cDefaultValue.a) ); };

aint* mudbox::Preferences::RegisterIntegerVariable (  const QString &  sName, const QString &  sCategory, int  iDefaultValue )  [inline]

{ return (aint *)RegisterVariable( sName, sCategory, Attribute::typeInt, QString("%1").arg(iDefaultValue) ); };

avector* mudbox::Preferences::RegisterVectorVariable (  const QString &  sName, const QString &  sCategory, const mudbox::Vector &  vDefaultValue )  [inline]

{ return (avector *)RegisterVariable( sName, sCategory, Attribute::typeVector, QString("%f %f %f").arg(vDefaultValue.x).arg(vDefaultValue.y).arg(vDefaultValue.z ) ); };

aenum* mudbox::Preferences::RegisterEnumVariable (  const QString &  sName, const QString &  sCategory, int  iDefaultValue )  [inline]

{ return (aenum *)RegisterVariable( sName, sCategory, Attribute::typeEnum, QString("%1").arg(iDefaultValue) ); };

void mudbox::Preferences::OnNodeEvent (  const Attribute &  , NodeEventType  )  [virtual]

Reimplemented from mudbox::Node.

---

Member Data Documentation

abool mudbox::Preferences::m_bCheckFrustum

abool mudbox::Preferences::m_bMultiThreadRender

abool mudbox::Preferences::m_bHighlightBrushArea

aint mudbox::Preferences::m_iFastBrushLevel

abool mudbox::Preferences::m_bFocusWhenEmpty

abool mudbox::Preferences::m_bFocusWhenNotEmpty

abool mudbox::Preferences::m_bZoomWhileFocus

abool mudbox::Preferences::m_bPickBothSide

abool mudbox::Preferences::m_bUseVideoMemory

abool mudbox::Preferences::m_bRemoveLevels

abool mudbox::Preferences::m_bRemoveOctree

abool mudbox::Preferences::m_bCreateUVs

abool mudbox::Preferences::m_bSmoothUV

abool mudbox::Preferences::m_bSmoothPos

aenum mudbox::Preferences::m_eDefaultMaterial

abool mudbox::Preferences::m_bDisableLODChange

abool mudbox::Preferences::m_bNoPaintUndo

aint mudbox::Preferences::m_fMinPenPressure

aint mudbox::Preferences::m_fMaxPenPressure

aint mudbox::Preferences::m_iGridSize

aint mudbox::Preferences::m_iGridSteps

aint mudbox::Preferences::m_iDoubleClickTime

abool mudbox::Preferences::m_bWireOnShaded

abool mudbox::Preferences::m_bShowPickedFace

aint mudbox::Preferences::m_iWireLevel

aenum mudbox::Preferences::m_eImportAutofocus

bool mudbox::Preferences::m_bFlatLighting

bool mudbox::Preferences::m_bFacetedShading

bool mudbox::Preferences::m_bLighting

afloatr mudbox::Preferences::m_fCameraDollySensitivity

afloatr mudbox::Preferences::m_fCameraTrackSensitivity

afloatr mudbox::Preferences::m_fCameraRotateSensitivity

abool mudbox::Preferences::m_bOptimizeMeshes

abool mudbox::Preferences::m_bShowLayerMask

abool mudbox::Preferences::m_bUseDraftRender

abool mudbox::Preferences::m_bShowFrozenVertices

aint mudbox::Preferences::m_iPointRenderRarity

aint mudbox::Preferences::m_iDraftRenderMinFaceCount

abool mudbox::Preferences::m_bHUDProjectedSubdiv

abool mudbox::Preferences::m_bHUDSelected

abool mudbox::Preferences::m_bHUDVisible

abool mudbox::Preferences::m_bHUDFPS

abool mudbox::Preferences::m_bHUDRendered

aint mudbox::Preferences::m_iHUDProjectedXSubdivisionLevel

aint mudbox::Preferences::m_iMinutesToAlarm

aint mudbox::Preferences::m_iBuildUpRate

afloatr mudbox::Preferences::m_fPressureTreshold

afloatr mudbox::Preferences::m_fStencilRotateSensitivity

abool mudbox::Preferences::m_bForceVidmemRender

abool mudbox::Preferences::m_bUseLocalYForCameraRotation

aenum mudbox::Preferences::m_iCameraControlMode

afloatr mudbox::Preferences::m_fRollArea

aint mudbox::Preferences::m_iMaximumTextureSize

abool mudbox::Preferences::m_bSaveIndicator

abool mudbox::Preferences::m_bSelectPicked

abool mudbox::Preferences::m_bLocalFocus

aint mudbox::Preferences::m_iMirrorPlanes

Store<mudbox::Vector> mudbox::Preferences::m_aMirrorPlaneNormals

Store<mudbox::Vector> mudbox::Preferences::m_aMirrorPlanePositions

abool mudbox::Preferences::m_bMirrorLocal

afloatr mudbox::Preferences::m_fSmartFocus

acolor mudbox::Preferences::m_cViewportCenter

acolor mudbox::Preferences::m_cViewportTop

acolor mudbox::Preferences::m_cViewportBottom

acolor mudbox::Preferences::m_cViewportFlat

acolor mudbox::Preferences::m_cGrid

acolor mudbox::Preferences::m_cGridAxis

acolor mudbox::Preferences::m_cLocked

acolor mudbox::Preferences::m_cSelection

acolor mudbox::Preferences::m_cMask

acolor mudbox::Preferences::m_cActiveLayer

acolor mudbox::Preferences::m_cInactiveLayer

acolor mudbox::Preferences::m_cLayerMask

acolor mudbox::Preferences::m_cSceneInfoBg

acolor mudbox::Preferences::m_cFalloffCurve

acolor mudbox::Preferences::m_cFalloffHull

acolor mudbox::Preferences::m_cFalloffFill

aenum mudbox::Preferences::m_eUnitLinear

aenum mudbox::Preferences::m_eFaceSelectionMode

aenum mudbox::Preferences::m_eObjectSelectionMode

float mudbox::Preferences::m_aLinearUnitRates[4]

astring mudbox::Preferences::m_sDefaultObjDir

astring mudbox::Preferences::m_sDefaultMudDir

astring mudbox::Preferences::m_sDefaultStampDir

astring mudbox::Preferences::m_sDefaultStencilDir

astring mudbox::Preferences::m_sDefaultIconDir

astring mudbox::Preferences::m_sDefaultImagePlaneDir

astring mudbox::Preferences::m_sDefaultTextureLayerDir

astring mudbox::Preferences::m_sDefaultPSDDir

astring mudbox::Preferences::m_sDefaultSaveScreenDir

astring mudbox::Preferences::m_sUserName

astring mudbox::Preferences::m_sLogPath

astring mudbox::Preferences::m_sTempPath

astring mudbox::Preferences::m_sSettingsPath

astring mudbox::Preferences::m_sDataPath

astring mudbox::Preferences::m_sTexturePath

astring mudbox::Preferences::m_sMayaInstallPath

abool mudbox::Preferences::m_bPathsChanged

abool mudbox::Preferences::m_bExpertHidesSouth

abool mudbox::Preferences::m_bExpertHidesEast

abool mudbox::Preferences::m_bExpertHidesMenu

abool mudbox::Preferences::m_bExpertHidesStatus

aint mudbox::Preferences::m_iDragBoxSize

abool mudbox::Preferences::m_bShowLearningMovies

abool mudbox::Preferences::m_bShowWelcomeDialog

abool mudbox::Preferences::m_bHUDInfoMessage

abool mudbox::Preferences::m_bHUDHelpMessage

aenum mudbox::Preferences::m_iHelpType

astring mudbox::Preferences::m_sHelpLocation

abool mudbox::Preferences::m_bCompressFiles

abool mudbox::Preferences::m_bOBJThumbnail

abool mudbox::Preferences::m_bMUDContainsView

abool mudbox::Preferences::m_bMUDContainsBrush

abool mudbox::Preferences::m_bCull

abool mudbox::Preferences::m_bCreateBackup

abool mudbox::Preferences::m_bShowTileInfo

aint mudbox::Preferences::m_iMapWidth

aint mudbox::Preferences::m_iMapHeight

astring mudbox::Preferences::m_sOutputDir

abool mudbox::Preferences::m_bExtractNormal

abool mudbox::Preferences::m_bExtractDisplacement

abool mudbox::Preferences::m_bSmoothNormals

aint mudbox::Preferences::m_iSmoothLevel

aint mudbox::Preferences::m_iNormalSpace

afloat mudbox::Preferences::m_fRayTravel

aint mudbox::Preferences::m_eRayCenter

abool mudbox::Preferences::m_bPickBothSides

aint mudbox::Preferences::m_iEdgeBleed

aint mudbox::Preferences::m_iNormalFormat

aint mudbox::Preferences::m_iDisplacementFormat

aint mudbox::Preferences::m_iSubdivLow

astring mudbox::Preferences::m_sNormalFileName

astring mudbox::Preferences::m_sDisplacementFileName

abool mudbox::Preferences::m_bSkipEmptyMaps

aint mudbox::Preferences::m_iExtUDim

aint mudbox::Preferences::m_iUStart

abool mudbox::Preferences::m_bSelectedFacesOnly

astring mudbox::Preferences::m_sLowObjectName

astring mudbox::Preferences::m_sHighObjectName

abool mudbox::Preferences::m_bInvertTangent

abool mudbox::Preferences::m_bInvertBinormal

afloat mudbox::Preferences::m_fAreaTreshold

astring mudbox::Preferences::m_sTileRange

afloat mudbox::Preferences::m_fMiddleValue

aint mudbox::Preferences::m_iFirstTileIndex

aint mudbox::Preferences::m_iDispUDim

aint mudbox::Preferences::m_iMaskChannel

aint mudbox::Preferences::m_iNegativeDisplacementChannel

aint mudbox::Preferences::m_iPositiveDisplacementChannel

aint mudbox::Preferences::m_iXSubdivisionLevel

astring mudbox::Preferences::m_sObjectName

astring mudbox::Preferences::m_sDisplacementFileMask

astring mudbox::Preferences::m_sMaskFileMask

aenum mudbox::Preferences::m_eTextureRatio

afloat mudbox::Preferences::m_fTextureRatio

avoid mudbox::Preferences::m_lExpertModeLabel

abool mudbox::Preferences::m_bMultisampling

astring mudbox::Preferences::m_sNextCommand

Store<Attribute *> mudbox::Preferences::m_aPluginAttributes

afloatr mudbox::Preferences::m_fPaintBleedDistance

Specifies a distance how far the edge bleeding should go over UV edges during painting.

afloatr mudbox::Preferences::m_fPaintBrushOffset

abool mudbox::Preferences::m_bFastDryBrush

astring mudbox::Preferences::m_sExportFilter

abool mudbox::Preferences::m_bHideEULANag

aint mudbox::Preferences::m_movieWidth

movie-recording preferences

aint mudbox::Preferences::m_movieHeight

aint mudbox::Preferences::m_movieRecordFps

aint mudbox::Preferences::m_moviePlaybackFps

abool mudbox::Preferences::m_moviePauseWhenIdle

abool mudbox::Preferences::m_movieUses3dView

---

mudbox::Preferences mudbox::Preferences mudbox::Preferences mudbox::Preferences mudbox::Preferences mudbox::Preferences mudbox::Preferences mudbox::Preferences mudbox::Preferences mudbox::Preferences

mudbox::Preferences mudbox::Preferences mudbox::Preferences mudbox::Preferences mudbox::Preferences mudbox::Preferences mudbox::Preferences mudbox::Preferences mudbox::Preferences mudbox::Preferences