c4d_tooldata.h File Reference

Classes

struct   ControlDisplayStruct
class   EditorWindow
class   ToolData

Macros

#define  PLUGINFLAG_TOOL_EVALUATEHANDLES
#define  PLUGINFLAG_TOOL_DRAW_MULTIPLANE
#define  PLUGINFLAG_TOOL_TWEAK
#define  PLUGINFLAG_TOOL_HIGHLIGHT
#define  PLUGINFLAG_TOOL_EDITSTATES
#define  PLUGINFLAG_TOOL_SNAPSETTINGS
#define  PLUGINFLAG_TOOL_SINGLECLICK
#define  PLUGINFLAG_TOOL_TWEAK_NO_HIGHLIGHT
#define  PLUGINFLAG_TOOL_NO_WIREFRAME
#define  PLUGINFLAG_TOOL_SCULPTBRUSH
#define  PLUGINFLAG_TOOL_NO_OBJECTOUTLINE
#define  PLUGINFLAG_TOOL_OBJECTHIGHLIGHT
#define  PLUGINFLAG_TOOL_SWITCHACTION
#define  PLUGINFLAG_TOOL_IS_SELECTION
#define  PLUGINFLAG_TOOL_NO_TOPOLOGY_EDIT

Enumerations

enum   VERTEXCOLOR_DISPLAYMODE {
   NONE ,
   COLOR ,
   ALPHA
}
enum   {
   PENPRESSURE ,
   PENTILT ,
   PENROTATION ,
   PENDRAWROTATION ,
   PENDRAWRANDOMNESS ,
   PENDRAWWHEELROTATION ,
   PENDRAWWHEELPRESSURE ,
   PENDRAWDISTANCE ,
   PENFINGERWHEEL
}

函数

enum VERTEXCOLOR_DISPLAYMODE   MAXON_ENUM_FLAGS ( VERTEXCOLOR_DISPLAYMODE )
BaseContainer GetToolData ( BaseDocument *doc, Int32 pluginid)
Float   GetToolScale ( BaseDraw *bd, AtomArray *arr, Int32 all, Int32 mode=-1)
Bool   RegisterToolPlugin ( Int32 id, const maxon::String &str, Int32 info, BaseBitmap *icon, const maxon::String &help, ToolData *dat)

变量

  NONE
  COLOR
  ALPHA
struct ControlDisplayStruct   MAXON_ENUM_FLAGS

Enumeration Type Documentation

◆  VERTEXCOLOR_DISPLAYMODE

enum VERTEXCOLOR_DISPLAYMODE
strong
Enumerator
NONE 
COLOR 
ALPHA 

Function Documentation

◆  MAXON_ENUM_FLAGS()

enum VERTEXCOLOR_DISPLAYMODE MAXON_ENUM_FLAGS ( VERTEXCOLOR_DISPLAYMODE   )

◆  GetToolData()

BaseContainer * GetToolData ( BaseDocument doc ,
Int32   pluginid  
)

Gets the data container for the tool with ID pluginid .

参数
[in] doc The document to get the settings for. The caller owns the pointed document.
[in] pluginid The plugin ID of the tool to get the data for.
返回
The tool data container. Cinema 4D owns the pointed container.

◆  GetToolScale()

Float GetToolScale ( BaseDraw bd ,
AtomArray arr ,
Int32   all ,
Int32   mode = -1  
)

Retrieves the scale between the local size of the objects in arr and their screen size in bd . The scale is quantized to a power of 10 .
例如:

Object size (units) Screen size (px) 比例

100

100

1

100

900

1

100

1001

0.1

100

10

10

注意
Useful to make mouse movements relative to the view size.
参数
[in] bd The view to check the scale in. The caller owns the pointed base draw.
[in] arr The array with objects to check. The caller owns the pointed array.
[in] all true all points are used for the calculation. If false the selection is used. If NOTOK the function checks if something is selected.
[in] mode NOTOK to use the bounding box (default) or Mpoints / Medges / Mpolygons .
返回
The calculated scale.

◆  RegisterToolPlugin()

Bool RegisterToolPlugin ( Int32   id ,
const maxon::String str ,
Int32   info ,
BaseBitmap icon ,
const maxon::String help ,
ToolData dat  
)

Registers a tool plugin.

参数
[in] id A unique plugin ID. Must be obtained from http://www.plugincafe.com
[in] str The name of the plugin.
To affect the order that plugins are displayed in menus add "#$n" as a prefix to this name, where n is a number.
Lower numbers are displayed before higher numbers. If name is "--" it will show up as a menu separator.
[in] info The tool plugin info flags: PLUGINFLAG_TOOL PLUGINFLAG
[in] icon The icon for the tool. The bitmap is copied.
The icon should be of size 32x 32 , but will be scaled if needed.
It must also be 24 bits and should if possible include an alpha to support pattern backgrounds.
[in] help The tool tips and status bar help text for the tool.
When using strings it is advised to use the resources string ( .str) files and the GeLoadString() 函数。
This keeps the plugin easy to localize for any language to support and makes full use of the language features of Cinema 4D .
[in] dat The tool data instance for the plugin. Cinema 4D takes over the ownership of the pointed tool data.
返回
true if the tool plugin was registered, otherwise false .

Variable Documentation

◆  NONE

NONE

◆  COLOR

COLOR

◆  ALPHA

ALPHA

◆  MAXON_ENUM_FLAGS

struct ControlDisplayStruct MAXON_ENUM_FLAGS