lib_sculptbrush.h File Reference

Classes

class  SculptFlagChecker
 
class  SculptPointPolysIterator
 
struct  SculptMouseData
 
struct  SculptCustomData
 
struct  BrushPointData
 
struct  BrushPolyData
 
class  BrushDabData
 
class  CustomSculptBrushBase
 
class  SculptBrushParams
 
class  SculptBrushToolData
 
class  SculptBrushModifierData
 
class  SculptModifierInterface
 

Macros

#define LIBRARY_SCULPTBRUSH
 

Enumerations

enum class  SCULPTBRUSHID {
  SMOOTH ,
  PULL ,
  FLATTEN ,
  PINCH ,
  ERASE ,
  GRAB ,
  MASK ,
  KNIFE ,
  WAX ,
  INFLATE ,
  FILL ,
  SCRAPE ,
  REPEAT ,
  AMPLIFY ,
  SELECT
}
 
enum class  FIRSTHITPPOINTTYPE {
  SELECTED ,
  AVERAGE
}
 
enum class  SCULPTBRUSHMODE {
  NORMAL ,
  GRAB
}
 
enum class  SCULPTBRUSHDATATYPE {
  NONE ,
  POINT ,
  MASK ,
  COLOR ,
  DIRTYPOINTS
}
 
enum class  OVERRIDE {
  NONE ,
  INVERT ,
  SMOOTH ,
  SMOOTHTOOL
}
 
enum class  SAMPLEMODE { TAKEONEPIXEL }
 
enum class  SCULPTOFFSETFLAGS {
  NONE ,
  RESPECTSTRENGTH ,
  IGNOREMASK
}
 

Functions

enum SCULPTBRUSHID MAXON_ENUM_LIST (SCULPTBRUSHID)
 
enum FIRSTHITPPOINTTYPE MAXON_ENUM_LIST (FIRSTHITPPOINTTYPE)
 
enum SCULPTBRUSHMODE MAXON_ENUM_LIST (SCULPTBRUSHMODE)
 
enum SCULPTBRUSHDATATYPE MAXON_ENUM_FLAGS (SCULPTBRUSHDATATYPE)
 
enum OVERRIDE MAXON_ENUM_FLAGS (OVERRIDE)
 
enum SAMPLEMODE MAXON_ENUM_FLAGS (SAMPLEMODE)
 
enum SCULPTOFFSETFLAGS MAXON_ENUM_FLAGS (SCULPTOFFSETFLAGS)
 
Bool RegisterBrushModifier (Int32 id, const String &name, DataAllocator *g, SCULPTBRUSHMODE mode, SCULPTBRUSHDATATYPE type, const String &resource, Bool hide=false, maxon::BaseArray< Int32 > *brushFilters=nullptr, maxon::BaseArray< Int32 > *brushRestrictions=nullptr, Int32 diskLevel=0)
 
Bool AddSculptBrushModifierFunction (Int32 id, String name, SCULPTBRUSHMODE mode, SCULPTBRUSHDATATYPE type, maxon::BaseArray< Int32 > *brushFilters=nullptr, maxon::BaseArray< Int32 > *brushRestrictions=nullptr, Bool hide=false)
 
Bool IsSculptBrush (Int32 toolID)
 
SculptBrushToolDataGetSelectedSculptBrush (BaseDocument *doc)
 

Variables

class CINEWARE_SINGLEINHERITANCE iSculptBrushBase
 
 SMOOTH
 
 PULL
 
 FLATTEN
 
 PINCH
 
 ERASE
 
 GRAB
 
 MASK
 
 KNIFE
 
 WAX
 
 INFLATE
 
 FILL
 
 SCRAPE
 
 REPEAT
 
 AMPLIFY
 
 SELECT
 
 SELECTED
 
 AVERAGE
 
 NORMAL
 
 NONE
 
 POINT
 
 COLOR
 
 DIRTYPOINTS
 
 INVERT
 
 SMOOTHTOOL
 
 TAKEONEPIXEL
 
 RESPECTSTRENGTH
 
 IGNOREMASK
 
class SculptFlagChecker MAXON_ENUM_FLAGS
 

Variable Documentation

◆ SMOOTH

SMOOTH

Smooth brush ID.

The user is holding down the Shift key and a smooth operation should be done.
Brushes can choose to specify their own operation for smooth, like the Mask Tool which does a blur.

◆ PULL

PULL

Pull brush ID.

◆ FLATTEN

FLATTEN

Flatten brush ID.

◆ PINCH

PINCH

Pinch brush ID.

◆ ERASE

ERASE

Erase brush ID.

◆ GRAB

GRAB

Grab brush ID.

Calculates affected points, hit point and normal the first time the user clicks.
These are the only points that are affected as the user moves the mouse.
This mode is used by the Grab Tool which uses the BrushDabData::GetMousePos3D() method to get the mouse position in 3D space as the user moves it.

◆ MASK

MASK

Mask brush ID.

The mask data is changed.

◆ KNIFE

KNIFE

Knife brush ID.

◆ WAX

WAX

Wax brush ID.

◆ INFLATE

INFLATE

Inflate brush ID.

◆ FILL

FILL

Fill brush ID.

◆ SCRAPE

SCRAPE

Scrape brush ID.

◆ REPEAT

REPEAT

Repeat brush ID.

◆ AMPLIFY

AMPLIFY

Amplify brush ID.

◆ SELECT

SELECT

Select brush ID.

◆ SELECTED

SELECTED

Use the exact hit location on the surface as the hit point.

◆ AVERAGE

AVERAGE

Use the average location of all the points that the brush dab touches.

◆ NORMAL

NORMAL

Samples the surface as the user moves over it the SculptObject and returns a new hit point and normal each time.

◆ NONE

NONE

None.

◆ POINT

POINT

The points are changed.

◆ COLOR

COLOR

Internal.

◆ DIRTYPOINTS

DIRTYPOINTS

Internal. Used by tiles to check if all its points have already been marked as dirty or not.

◆ INVERT

INVERT

If the user holds down the Ctrl key then the brush should Invert its functionality.

◆ SMOOTHTOOL

SMOOTHTOOL

Internal. Used to specify that the smooth is tool specific.

◆ TAKEONEPIXEL

TAKEONEPIXEL

Takes the exact pixel at the intersection point.

◆ RESPECTSTRENGTH

RESPECTSTRENGTH

Respect the Strength of the current layer.

◆ IGNOREMASK

IGNOREMASK

Ignore the Mask setting for the current layer.