Manipulate Grip Items

Module description

The different select and manipulate mode grip items that can be toggled on or off.

Enumerations
enum	ManipulateGrips {   eSoftSelFalloff = 0, eSoftSelPinch, eSoftSelBubble, eSetFlow,   eLoopShift, eRingShift, eEdgeCrease, eEdgeWeight,   eVertexWeight, eVertexCrease, EPolyManipulatorGripCount }
enum	ManipulateGrips {   eSoftSelFalloff = 0, eSoftSelPinch, eSoftSelBubble, eSetFlow,   eLoopShift, eRingShift, eEdgeCrease, eEdgeWeight,   eVertexCrease, eVertexWeight, EditPolyManipulatorGripCount }

Functions
virtual void	SetManipulateGrip (bool on, ManipulateGrips item)=0
	Turns the manipulate grip item on or off. More...
virtual bool	GetManipulateGrip (ManipulateGrips item)=0
	Get whether or not this manipulator item is on or not. More...
	FN_1 (epfn_make_hard_edges, TYPE_BOOL, EpfnMakeHardEdges, TYPE_DWORD)
	FN_1 (epfn_make_smooth_edges, TYPE_BOOL, EpfnMakeSmoothEdges, TYPE_DWORD)
	VFN_0 (epfn_select_hard_edges, EpfnSelectHardEdges)
	VFN_0 (epfn_select_smooth_edges, EpfnSelectSmoothEdges)
virtual bool	EpfnMakeHardEdges (DWORD flag)=0
	Make the edges marked with the specified flag hard (unsmoothed) More...
virtual bool	EpfnMakeSmoothEdges (DWORD flag)=0
	Make the edges marked with the specified flag smooth. More...
virtual void	EpfnSelectHardEdges ()=0
	Select hard (unsmoothed) edges. More...
virtual void	EpfnSelectSmoothEdges ()=0
	Select smoothed edges. More...
	PROP_FNS (epfn_get_edge_chamfer_type, EpFnGetEdgeChamferType, epfn_set_edge_chamfer_type, EpFnSetEdgeChamferType, TYPE_ENUM)
	PROP_FNS (epfn_get_edge_chamfer_quad_intersections, EpFnGetEdgeChamferQuadIntersections, epfn_set_edge_chamfer_quad_intersections, EpFnSetEdgeChamferQuadIntersections, TYPE_BOOL)
virtual int	EpFnGetEdgeChamferType ()
	Get the current Edit Poly Edge Chamfer type (obsolete). More...
virtual void	EpFnSetEdgeChamferType (int chamferType)
	Set the current Edit Poly Edge Chamfer type (obsolete). More...
virtual bool	EpFnGetEdgeChamferQuadIntersections ()
	Get the current Edit Poly Edge Chamfer quad intersections (obsolete). More...
virtual void	EpFnSetEdgeChamferQuadIntersections (bool quadIntersections)
	Set the current Edit Poly Edge Chamfer quad intersections (obsolete). More...

Enumeration Type Documentation

enum ManipulateGrips

protected

Enumerator
eSoftSelFalloff	Soft Selection Falloff grip. May be on for all subobject modes.
eSoftSelPinch	Soft Selection Pinch grip. May be on for all subobject modes.
eSoftSelBubble	Soft Selection Bubble grip. May be on for all subobject modes.
eSetFlow	Set Flow grip. Only on in edge subobject mode.
eLoopShift	Loop Shift Selection Falloff grip. Only in edge subobject mode.
eRingShift	Ring Shift Selection Falloff grip. Only in edge subobject mode.
eEdgeCrease	Edge Crease grip. Only in edge subobject mode.
eEdgeWeight	Edge Weight grip. Only in edge subobject mode.
eVertexWeight	Vertex Weight grip. Only in vertex subobject mode.
eVertexCrease	Vertex Crease grip. Only in vertex subobject mode.
EPolyManipulatorGripCount

    {
        eSoftSelFalloff = 0,
        eSoftSelPinch,
        eSoftSelBubble,
        eSetFlow,
        eLoopShift,
        eRingShift,
        eEdgeCrease,
        eEdgeWeight,
        eVertexWeight,
        eVertexCrease,
        // The following is an end-of-enums semaphore -- Used to get the count of enums here.
        // Leave it as the last entry.
        EPolyManipulatorGripCount
    };

enum ManipulateGrips

protected

Enumerator
eSoftSelFalloff	Soft Selection Falloff grip. May be on for all subobject modes.
eSoftSelPinch	Soft Selection Pinch grip. May be on for all subobject modes.
eSoftSelBubble	Soft Selection Bubble grip. May be on for all subobject modes.
eSetFlow	Set Flow grip. Only on in edge subobject mode.
eLoopShift	Grow Shift Selection Falloff grip. Only in edge subobject mode.
eRingShift	Right Shift Selection Falloff grip. Only in edge subobject mode.
eEdgeCrease
eEdgeWeight
eVertexCrease
eVertexWeight
EditPolyManipulatorGripCount

    {
        eSoftSelFalloff = 0,
        eSoftSelPinch,
        eSoftSelBubble,
        eSetFlow,
        eLoopShift,
        eRingShift,
        // (Extensions for Phoenix start here)
        // Edge Crease grip.  Only in edge subobject mode.
        eEdgeCrease,
        // Edge Weight grip.  Only in edge subobject mode.
        eEdgeWeight,
        // Vertex Crease grip.  Only in vertex subobject mode.
        eVertexCrease,
        // Vertex Weight grip.  Only in vertex subobject mode.
        eVertexWeight,
        // The following is a semaphore that indicates the total enum count.
        // Please leave as the last entry for proper operation
        EditPolyManipulatorGripCount
    };

Function Documentation

virtual void SetManipulateGrip ( bool  on, ManipulateGrips  item  )

protectedpure virtual

Turns the manipulate grip item on or off.

When at least one grip item is on and select and manipulate mode is on a grip will show up for each item that's on.

Parameters

[in]	on	- Whether or not the specified item will be turned on or off
[in]	item	- Which grip item that will be turned on or off.

virtual bool GetManipulateGrip ( ManipulateGrips  item )

protectedpure virtual

Get whether or not this manipulator item is on or not.

Parameters

[in]

item

- Which grip item we are checking to see if it's on or off.

Returns

Whether or not the item is on or not. Note that it doesn't take into account whether or not the correct subobject mode is also active, it just checks to see if it would be on if we were in the right mode.

FN_1	(	epfn_make_hard_edges	,
		TYPE_BOOL	,
		EpfnMakeHardEdges	,
		TYPE_DWORD
	)

FN_1	(	epfn_make_smooth_edges	,
		TYPE_BOOL	,
		EpfnMakeSmoothEdges	,
		TYPE_DWORD
	)

VFN_0	(	epfn_select_hard_edges	,
		EpfnSelectHardEdges
	)

VFN_0	(	epfn_select_smooth_edges	,
		EpfnSelectSmoothEdges
	)

virtual bool EpfnMakeHardEdges ( DWORD  flag )

pure virtual

Make the edges marked with the specified flag hard (unsmoothed)

Parameters

flag	- Edges marked with this flag (MNMesh Flags) will be set to hard if possible by setting appropriate smoothing groups in adjacent faces.

Returns

true if any faces had smooothing groups altered

virtual bool EpfnMakeSmoothEdges ( DWORD  flag )

pure virtual

Make the edges marked with the specified flag smooth.

Parameters

flag	- Edges marked with this flag (MNMesh Flags) will be set to smooth if possible by setting appropriate smoothing groups in adjacent faces.

Returns

true if any faces had smooothing groups altered

virtual void EpfnSelectHardEdges ( )

pure virtual

Select hard (unsmoothed) edges.

This operation selects edges between any faces which do not share any smoothing groups.

virtual void EpfnSelectSmoothEdges ( )

pure virtual

Select smoothed edges.

This operation selects edges between any faces which share any smoothing groups.

PROP_FNS	(	epfn_get_edge_chamfer_type	,
		EpFnGetEdgeChamferType	,
		epfn_set_edge_chamfer_type	,
		EpFnSetEdgeChamferType	,
		TYPE_ENUM
	)

PROP_FNS	(	epfn_get_edge_chamfer_quad_intersections	,
		EpFnGetEdgeChamferQuadIntersections	,
		epfn_set_edge_chamfer_quad_intersections	,
		EpFnSetEdgeChamferQuadIntersections	,
		TYPE_BOOL
	)

virtual int EpFnGetEdgeChamferType ( )

inlinevirtual

Get the current Edit Poly Edge Chamfer type (obsolete).

Returns

The current Edit Poly Edge Chamfer type, or -1 if the current type is not any of the Edit Poly Edge Chamfer types.

{ return -1; }

virtual void EpFnSetEdgeChamferType ( int  chamferType )

inlinevirtual

Set the current Edit Poly Edge Chamfer type (obsolete).

Parameters

[in]

chamferType

- Standard = 0, Quad = 1.

{ }

virtual bool EpFnGetEdgeChamferQuadIntersections ( )

inlinevirtual

Get the current Edit Poly Edge Chamfer quad intersections (obsolete).

Returns

The current Edit Poly Edge Chamfer quadIntersections

{ return FALSE; }

virtual void EpFnSetEdgeChamferQuadIntersections ( bool  quadIntersections )

inlinevirtual

Set the current Edit Poly Edge Chamfer quad intersections (obsolete).

Parameters

[in]

quadIntersections

{ }