Magnet

About

• Header File: c4d_objects/description/toolmagnet.h
• Description Category: Tools. An interactive tool. See Active Tool.
• Included Description:
  • Base Tool

Parameters

Parameters are accessed with C4DAtom::GetParameter()/ C4DAtom::SetParameter(). See page_maxonapi_getting_started_foundations_cinema_parameters.

---

Parameter: Radius

• Parameter ID: MDATA_MAGNET_FALLOFF_RADIUS
• Parameter Type: maxon::Float (Basic Data Types)

---

Parameter: Strength

• Parameter ID: MDATA_MAGNET_FALLOFF_STRENGTH
• Parameter Type: maxon::Float (Basic Data Types)

---

Parameter: Mode

• Parameter ID: MDATA_MAGNET_EFFECTMODE
• Parameter Type: maxon::Int32 (Basic Data Types)
• Cycle Values:
  • Smear (MDATA_MAGNET_MODE_SMEAR)
  • Pull (MDATA_MAGNET_MODE_PULL)
  • Surface (MDATA_MAGNET_MODE_SURFACE)
  • Normal (MDATA_MAGNET_MODE_NORMAL)
  • Repel (MDATA_MAGNET_MODE_SPREAD)
  • Spin (MDATA_MAGNET_MODE_SPIN)
  • Twister (MDATA_MAGNET_MODE_TWIST)
  • Vortex (MDATA_MAGNET_MODE_VORTEX)
  • Smooth (MDATA_MAGNET_MODE_SMOOTH)
  • Relax (MDATA_MAGNET_MODE_RELAX)
  • Surface Smear (MDATA_MAGNET_MODE_SURFACE_SMEAR)

---

Parameter: Visible Only

• Parameter ID: MDATA_MAGNET_MOVEONLYVISIBLE
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Surface

• Parameter ID: MDATA_MAGNET_CONNECTED
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Preview

• Parameter ID: MDATA_MAGNET_PREVIEW
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Nearest Point

• Parameter ID: MDATA_MAGNET_NEAREST
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Snap Visible

• Parameter ID: MDATA_MAGNET_VISIBLEONLY
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Preserve Boundary

• Parameter ID: MDATA_MAGNET_PRESERVE_BOUNDARY
• Parameter Type: maxon::Bool (Basic Data Types)

---

Parameter: Space

• Parameter ID: MDATA_MAGNET_RESTRICT
• Parameter Type: maxon::Int32 (Basic Data Types)
• Cycle Values:
  • World (MDATA_MAGNET_RESTRICT_WORLD)
  • Object (MDATA_MAGNET_RESTRICT_OBJECT)
  • Camera (MDATA_MAGNET_RESTRICT_CAMERA)

---

Parameter: X

• Parameter ID: MDATA_MAGNET_RESTRICT_X
• Parameter Type: maxon::Float (Basic Data Types)

---

Parameter: Y

• Parameter ID: MDATA_MAGNET_RESTRICT_Y
• Parameter Type: maxon::Float (Basic Data Types)

---

Parameter: Z

• Parameter ID: MDATA_MAGNET_RESTRICT_Z
• Parameter Type: maxon::Float (Basic Data Types)

---

Parameter: Falloff

• Parameter ID: MDATA_MAGNET_MODE
• Parameter Type: maxon::Int32 (Basic Data Types)
• Cycle Values:
  • Constant (MDATA_MAGNET_MODE_CONSTANT)
  • Linear (MDATA_MAGNET_MODE_LINEAR)
  • Dome (MDATA_MAGNET_MODE_DOME)
  • Bell (MDATA_MAGNET_MODE_BELL)
  • Circle (MDATA_MAGNET_MODE_CIRCLE)
  • Needle (MDATA_MAGNET_MODE_NEEDLE)
  • Spline (MDATA_MAGNET_MODE_USER)

---

Parameter: Width

• Parameter ID: MDATA_MAGNET_FALLOFF_WIDTH
• Parameter Type: maxon::Float (Basic Data Types)

---

Parameter: Spline

• Parameter ID: MDATA_MAGNET_FALLOFF
• Parameter Type: ::SplineData