lineModifier node

This node can be used to locally modify toon line attributes.

Node name	Parents	MFn type	Compatible function sets
lineModifier	shape	kLineModifier	kBase kNamedObject kDependencyNode kDagNode kShape kLineModifier

Related nodes

pfxToon, brush

Attributes (31)

branchDropout, color, colorB, colorG, colorR, directionalDisplacement, directionalForce, displacement, dropoff, dropoffNoise, dropoff_FloatValue, dropoff_Interp, dropoff_Position, flowerDropout, flowerScale, force, leafDropout, leafScale, lineExtend, modifyColor, noiseFrequency, opacityOffset, opacityScale, outLineModifier, shape, surfaceOffset, tubeDropout, tubeScale, twigDropout, widthOffset, widthScale

Long name (short name) Type Default Flags

shape (shp) enum 0

This determines the shape of the line modifier. There will be no effect outside the bounds of the selected shape. The dropoff graph attribute is defined relative to the shape, such that the right edge of the dropoff is the the outer edge of the shape, and the left is the shapes center.

widthScale (wsc) double 5.0

This value multiplies the current line width. A value of 1.0 will have no effect and a value of zero will scale the width to zero.

widthOffset (wof) double 0.0

This value adds onto the current line width. A value of 0.0 will have no effect and a value of 1.0 will grow the width by one.

opacityScale (osc) double 1.0

This value multiplies the current line opacity. A value of 1.0 will have no effect and a value of zero will scale the opacity to zero.

opacityOffset (oof) double 0.0

This value adds onto the current line opacity. A value of 0.0 will have no effect and a value of 1.0 will make the lines fully opaque.

surfaceOffset (sof) double 0.0

This value adds onto the current line surface offset. A value of 0.0 will have no effect and a value of 1.0 will increase the offset by 1.0. Negative values will clamp when an offset of 0 is achieved.

lineExtend (lex) double 0.0

This value adds onto the current line extend. A value of 0.0 will have no effect and a value of 1.0 will increase the extend by 1.0. Negative values will clamp when an extend of 0 is achieved.

modifyColor (mcl) bool false

If on then the color value is blended with the line color based on the droffoff value.

color (clr) float3

If modify color is on then this color is blended into the local line color based on the dropoff value.

colorR (crr) float 1.0

Red value

colorG (crg) float 0.0

Green value

colorB (crb) float 0.0

Blue value

tubeScale (tus) double 1.0

This can be used to scale the length and width of paint effects tubes generated. A value of 1.0 will have no effect and a value of 0.0 will scale the tubes to nothing, resulting in no tubes generated. The behavior is similar to modifying the brush global scale. To have an effect this requires hat a brush with tubes=ON be used.

tubeDropout (tud) double 0.0

This can be used to reduce the number of paint effects tubes generated. A value of 0.0 will have no effect and a value of 1.0 will result in no tubes generated. To have an effect this requires that a brush with tubes=ON be used.

branchDropout (bdp) double 0.0

This value adds onto the current branch dropout value used by the paint effects brush. A value of 0.0 will have no effect and a value of 1.0 will increase the dropout by 1.0. To have an effect this requires that a brush with tubes=ON and branches=ON be used.

twigDropout (tdp) double 0.0

leafDropout (ldp) double 0.0

This value adds onto the current leaf dropout value used by the paint effects brush. A value of 0.0 will have no effect and a value of 1.0 will increase the dropout by 1.0. To have an effect this requires that a brush with tubes=ON and leaves=ON be used.

flowerDropout (fdp) double 0.0

This value adds onto the current flower dropout value used by the paint effects brush. A value of 0.0 will have no effect and a value of 1.0 will increase the dropout by 1.0. To have an effect this requires that a brush with tubes=ON and flowers=ON be used.

leafScale (lsc) double 1.0

This value multiplies the size of leaves used by the paint effects brush. A value of 1.0 will have no effect and a value of 0.5 will reduce leaf size by half. To have an effect this requires that a brush with tubes=ON and leaves=ON be used.

flowerScale (fsc) double 1.0

This value multiplies the size of flowers used by the paint effects brush. A value of 1.0 will have no effect and a value of 0.5 will reduce flower size by half. To have an effect this requires that a brush with tubes=ON and flowers=ON be used.

force (frc) double 0.0

This acts as a force pushing tubes away from the center of the line modifier shape. Positive values will push away from the center while negative values will push towards the center. To have an effect this requires that a brush with tubes=ON be used.

directionalForce (dfc) double 0.0

This acts as a force pushing tubes along the local x axis of the line modifier shape. To have an effect this requires that a brush with tubes=ON be used.

displacement (dsp) double 0.0

This acts as a displacement pushing tubes away from the center of the line modifier shape. Positive values will push away from the center while negative values will push towards the center. This is similar to the force attribute, but tube segments further down the tube are not affected by the offset. To have an effect this requires that a brush with tubes=ON be used.

directionalDisplacement (ddc) double 0.0

This acts as a displacement pushing tubes along the local x axis of the line modifier shape. To have an effect this requires that a brush with tubes=ON be used. This is similar to the directional force attribute, but tube segments further down the tube are not affected by the offset.

dropoffNoise (don) double 0.0

This modulates the dropoff value with a 3D noise. This can provide variation for the parameters being modulated. For example the tube width can be randomized or wiggled in a noisy fashion using this attribute. The Noise Frequency attribute controls how detailed the noise is.

noiseFrequency (nfr) double 0.2

The Noise Frequency attribute controls how detailed the dropoff noise is. Lower values result in a smoother noise. The 3D noise is defined relative to the local space of the line modifier shape.

dropoff (drp) compound n/a

This determines the range of effect within the bounds of the modifier. If the dropoff is set to a constant value of 1.0 (horizontal line) then lines will be uniformly modified inside the bounds of the dropoff shape, with a hard transition at the shape edge. If the right edge of the dropoff is instead ramped down to zero the transition will be gradual, with no modulation at the shape edge, with increasing modulation towards its center. The dropoff graph attribute is defined relative to the shape, such that the right edge of the dropoff is the the outer edge of the shape, and the left is the shapes center.

dropoff_Position (drpp) float 0.0

Position of ramp value on normalized 0-1 scale

dropoff_FloatValue (drpfv) float 0.0

Ramp value at the sibling position

dropoff_Interp (drpi) enum 0

Ramp Interpolation controls the way the intermediate values are calculated. The values are:

None

Linear: The values are interpolated linearly in RGB color space.

Smooth: The values are interpolated along a bell curve, so that each color on the ramp dominates the region around it, then blends quickly to the next color.

Spline: The values are interpolated with a spline curve, taking neighboring indices into account for greater smoothness.

outLineModifier (olm) lineModifier NULL

output line modifier data for use by pfxToon node