formZ SDK | 5.0 API Reference | Project | Modeling | Objects | Editing Operations

# fz_objt_edit_deform_wave

Description

Applies a wave deformation to an object.
The wave originates at the origin and expands in the plane specified by plane_rot (three angles in zyx order that rotate the world coordinate ).
amplitude is the height of a peak or valley. If amplitude is a positive value, the first extreme of the wave is a peak. If it is negative the first extreme is a valley.
frequency is the distance between two wave peaks.
If circular is TRUE, the wave expands in a circular fashion from the origin. Otherwise the wave is linear, with the wave peaks and valleys running parallel to the y axis of the rotated coordinate .
If do_cosine is TRUE, the wave is a cosine wave (i.e. at the origin, the wave has a peak or valley). Otherwise the wave is a sine wave (wave is at mid level at the origin).
This deformation only works on facetted objects.
Objects should be sufficiently meshed as this function simply disturbs the points of an object in a wave like pattern. If the object meshing is too coarse relative to the wave frequency, the wave patterns won't be visible.

Plugin Prototype

fzrt_error_td fz_objt_edit_deform_wave(

fzrt_int | windex,
fz_objt_ptr | obj,
fz_xyz_td * | origin,
fz_map_plane_td * | plane,
double | amplitude,
double | frequency,
fzrt_boolean | circular,
fzrt_boolean | do_cosine )

Parameters

windex [Input]

project window index

obj [Input, Result]

object (must be facetted)

origin [Input]

point where wave originates

plane [Input]

coordinate which orients the axis of deformation

amplitude [Input]

height of a peak or valley

frequency [Input]

distance between two wave peaks

Range: frequency > 0.0

circular [Input]

if TRUE, the wave expands in a circular fashion from the origin, otherwise the wave is linear

do_cosine [Input]

if TRUE, the wave is a cosine wave, otherwise the wave is a sine wave

Returns

Error codes

Availability

5.0.0.0

Example Files

util_objt_deform.fsl

See Also

, fz_objt_edit_deform_taper,, , fz_objt_edit_deform_radial_shear, fz_objt_edit_deform_bend, fz_objt_edit_deform_bezier,,

Function Set

fz_model_fset

Defined in

fz_objt_api.h