SculptMouseData Struct Reference

#include <lib_sculptbrush.h>

Detailed Description

If SculptBrushParams::EnableMouseData(true) has been set for the brush then you will receive this data structure in the SculptBrushToolData::MouseData method as the mouse moves over the surface of the model.

Since
R17.032

Public Attributes

SculptObjectpObject
 
Vector mouseCoord
 
Vector hitPoint
 
Vector32 normal
 
Vector barryCoord
 
Int polygon
 
Bool mouseDrag
 
Float distance
 
Bool isBackface
 

Member Data Documentation

◆ pObject

SculptObject* pObject

The selected Object underneath the mouse.

◆ mouseCoord

Vector mouseCoord

The screen coordinates for the mouse location in the current viewport.

◆ hitPoint

Vector hitPoint

The hitpoint on the surface of the model at the center of the brush dab.

◆ normal

Vector32 normal

The normal on the surface of the model at the center of the brush dab.

◆ barryCoord

Vector barryCoord

The barycentric coordinates within the triangle for the hit polygon.

◆ polygon

Int polygon

The Index of the hit polygon.

◆ mouseDrag

Bool mouseDrag

This will be set to true if the mouse button is held down and being dragged in the viewport.

◆ distance

Float distance

The distance from the mouse in local space to the surface of the object.

◆ isBackface

Bool isBackface

This will be set to true if the polygon under the mouse is backfacing.