UT_Ramp Class Reference

#include <UT_Ramp.h>

List of all members.

Public Member Functions

UT_Ramp ()

UT_Ramp (const UT_Ramp &copy)

~UT_Ramp ()

void setColorType (UT_ColorType color_space)

UT_ColorType getColorType () const

void clearAndDestroy ()

void ensureRampIsBuilt ()

bool getGlobalEnable () const

void setGlobalEnable (bool enable)

int getNodeCount () const

const UT_ColorNode * getNode (int i) const

UT_ColorNode * getRamp ()

const UT_ColorNode * getRamp () const

void convertToRaster (UT_Raster *raster, UT_RampOrient dir, int doInterping=1, fpreal cx=0.0f, fpreal cy=0.0f, fpreal phase=0.0f, fpreal radius=1.0f)

const UT_ColorNode * getClosestNode (fpreal pos) const

int getClosestNodeIndex (fpreal pos) const

const UT_ColorNode * getCurrentNode () const

int getCurrentNodeIndex () const

void setCurrentNodeIndex (int i, bool add_to_selection)

void getColor (fpreal pos, UT_FRGBA *clr, int doInterping=1) const

void getColor (fpreal pos, float fvals[4], int doInterping=1) const

void getColor (UT_FRGBA *values, int num, int doInterping=1) const

void setColorAt (int i, float fvals[4])

void setColorAt (int i, const UT_FRGBA &clr)

void setCurrentNodeColor (fpreal32 fvals[4])

void setCurrentNodeColor (fpreal64 fvals[4])

void setCurrentNodeColor (const UT_FRGBA &clr)

void setCurrentNodeBasis (UT_SPLINE_BASIS basis)

void setNodeBasis (int i, UT_SPLINE_BASIS basis)

void setEnable (int i, bool enable_pos, bool enable_val, bool enable_interp)

bool getEnablePos (int i) const

bool getEnableVal (int i) const

bool getEnableInterp (int i) const

void clearSelection ()

bool isNodeSelected (int i)

void selectNode (int i, bool add)

void selectRange (int first_i, int last_i, bool add)

void deselectNode (int i)

void toggleSelectNode (int i)

void getSelectionIndices (UT_IntArray &indices)

void setSelectionIndices (const UT_IntArray &indices)

void addNode (fpreal pos)

void addNode (fpreal pos, fpreal32 fvals[4], UT_SPLINE_BASIS basis=UT_SPLINE_LINEAR)

void addNode (fpreal pos, fpreal64 fvals[4], UT_SPLINE_BASIS basis=UT_SPLINE_LINEAR)

void addNode (fpreal pos, const UT_FRGBA &color, UT_SPLINE_BASIS basis=UT_SPLINE_LINEAR)

bool deleteNode (fpreal pos)

bool deleteNodeAt (int i)

void deleteSelectedNodes ()

void moveNode (const UT_ColorNode *node, fpreal pos)

void moveNodeSelection (int node_i, fpreal pos)

int load (const char *pathname)

bool load (UT_IStream &is)

int save (const char *pathname) const

int save (ostream &os) const

UT_Ramp & operator= (const UT_Ramp &from)

bool operator== (const UT_Ramp &from) const

void setRamp (const UT_ColorNode *r, int size)

void rampLookup (fpreal pos, float values[4]) const

void rampLookupNoInterp (fpreal pos, float values[4]) const

void rampLookup (fpreal u0, fpreal u1, float values[4], int ns) const

void rampLookupNoInterp (fpreal u0, fpreal u1, float values[4], int ns) const

template<typename ARCHIVER_T >

bool serialize (ARCHIVER_T &archiver)

Detailed Description

Definition at line 95 of file UT_Ramp.h.

Constructor & Destructor Documentation

UT_Ramp::UT_Ramp ( )

UT_Ramp::UT_Ramp ( const UT_Ramp & copy )

UT_Ramp::~UT_Ramp ( )

Member Function Documentation

void UT_Ramp::addNode	(	fpreal	pos,
		const UT_FRGBA &	color,
		UT_SPLINE_BASIS	basis = `UT_SPLINE_LINEAR`
	)

void UT_Ramp::addNode	(	fpreal	pos,
		fpreal64	fvals[4],
		UT_SPLINE_BASIS	basis = `UT_SPLINE_LINEAR`
	)

void UT_Ramp::addNode	(	fpreal	pos,
		fpreal32	fvals[4],
		UT_SPLINE_BASIS	basis = `UT_SPLINE_LINEAR`
	)

void UT_Ramp::addNode ( fpreal pos )

void UT_Ramp::clearAndDestroy ( )

void UT_Ramp::clearSelection ( )

void UT_Ramp::convertToRaster	(	UT_Raster *	raster,
		UT_RampOrient	dir,
		int	doInterping = `1`,
		fpreal	cx = `0.0f`,
		fpreal	cy = `0.0f`,
		fpreal	phase = `0.0f`,
		fpreal	radius = `1.0f`
	)

bool UT_Ramp::deleteNode ( fpreal pos )

bool UT_Ramp::deleteNodeAt ( int i )

void UT_Ramp::deleteSelectedNodes ( )

void UT_Ramp::deselectNode ( int i )

void UT_Ramp::ensureRampIsBuilt ( ) [inline]

In order to safely access a UT_Ramp from multiple threads you need to ensure its lazily evaluated data is already allocated This method does just that.

Definition at line 111 of file UT_Ramp.h.

const UT_ColorNode* UT_Ramp::getClosestNode ( fpreal pos ) const

int UT_Ramp::getClosestNodeIndex ( fpreal pos ) const

void UT_Ramp::getColor	(	UT_FRGBA *	values,
		int	num,
		int	doInterping = `1`
	)			const

void UT_Ramp::getColor	(	fpreal	pos,
		float	fvals[4],
		int	doInterping = `1`
	)			const

void UT_Ramp::getColor	(	fpreal	pos,
		UT_FRGBA *	clr,
		int	doInterping = `1`
	)			const

UT_ColorType UT_Ramp::getColorType ( ) const [inline]

Definition at line 103 of file UT_Ramp.h.

const UT_ColorNode* UT_Ramp::getCurrentNode ( ) const

int UT_Ramp::getCurrentNodeIndex ( ) const

bool UT_Ramp::getEnableInterp ( int i ) const

bool UT_Ramp::getEnablePos ( int i ) const

bool UT_Ramp::getEnableVal ( int i ) const

bool UT_Ramp::getGlobalEnable ( ) const [inline]

Definition at line 113 of file UT_Ramp.h.

const UT_ColorNode* UT_Ramp::getNode ( int i ) const

int UT_Ramp::getNodeCount ( ) const [inline]

Definition at line 118 of file UT_Ramp.h.

const UT_ColorNode* UT_Ramp::getRamp ( ) const [inline]

Definition at line 123 of file UT_Ramp.h.

UT_ColorNode* UT_Ramp::getRamp ( ) [inline]

Definition at line 121 of file UT_Ramp.h.

void UT_Ramp::getSelectionIndices ( UT_IntArray & indices )

bool UT_Ramp::isNodeSelected ( int i )

bool UT_Ramp::load ( UT_IStream & is )

int UT_Ramp::load ( const char * pathname )

void UT_Ramp::moveNode	(	const UT_ColorNode *	node,
		fpreal	pos
	)

void UT_Ramp::moveNodeSelection	(	int	node_i,
		fpreal	pos
	)

UT_Ramp& UT_Ramp::operator= ( const UT_Ramp & from )

bool UT_Ramp::operator== ( const UT_Ramp & from ) const

void UT_Ramp::rampLookup	(	fpreal	u0,
		fpreal	u1,
		float	values[4],
		int	ns
	)			const

void UT_Ramp::rampLookup	(	fpreal	pos,
		float	values[4]
	)			const

void UT_Ramp::rampLookupNoInterp	(	fpreal	u0,
		fpreal	u1,
		float	values[4],
		int	ns
	)			const

void UT_Ramp::rampLookupNoInterp	(	fpreal	pos,
		float	values[4]
	)			const

int UT_Ramp::save ( ostream & os ) const

int UT_Ramp::save ( const char * pathname ) const

void UT_Ramp::selectNode	(	int	i,
		bool	add
	)

void UT_Ramp::selectRange	(	int	first_i,
		int	last_i,
		bool	add
	)

template<typename ARCHIVER_T >

bool UT_Ramp::serialize ( ARCHIVER_T & archiver ) [inline]

void UT_Ramp::setColorAt	(	int	i,
		const UT_FRGBA &	clr
	)

void UT_Ramp::setColorAt	(	int	i,
		float	fvals[4]
	)

void UT_Ramp::setColorType ( UT_ColorType color_space ) [inline]

Definition at line 101 of file UT_Ramp.h.

void UT_Ramp::setCurrentNodeBasis ( UT_SPLINE_BASIS basis )

void UT_Ramp::setCurrentNodeColor ( const UT_FRGBA & clr )

void UT_Ramp::setCurrentNodeColor ( fpreal64 fvals[4] )

void UT_Ramp::setCurrentNodeColor ( fpreal32 fvals[4] )

void UT_Ramp::setCurrentNodeIndex	(	int	i,
		bool	add_to_selection
	)

void UT_Ramp::setEnable	(	int	i,
		bool	enable_pos,
		bool	enable_val,
		bool	enable_interp
	)

void UT_Ramp::setGlobalEnable ( bool enable ) [inline]

Definition at line 115 of file UT_Ramp.h.

void UT_Ramp::setNodeBasis	(	int	i,
		UT_SPLINE_BASIS	basis
	)

void UT_Ramp::setRamp	(	const UT_ColorNode *	r,
		int	size
	)

void UT_Ramp::setSelectionIndices ( const UT_IntArray & indices )

void UT_Ramp::toggleSelectNode ( int i )

The documentation for this class was generated from the following file:

UT/UT_Ramp.h


Public Member Functions
	UT_Ramp ()
	UT_Ramp (const UT_Ramp &copy)
	~UT_Ramp ()
void	setColorType (UT_ColorType color_space)
UT_ColorType	getColorType () const
void	clearAndDestroy ()
void	ensureRampIsBuilt ()
bool	getGlobalEnable () const
void	setGlobalEnable (bool enable)
int	getNodeCount () const
const UT_ColorNode *	getNode (int i) const
UT_ColorNode *	getRamp ()
const UT_ColorNode *	getRamp () const
void	convertToRaster (UT_Raster *raster, UT_RampOrient dir, int doInterping=1, fpreal cx=0.0f, fpreal cy=0.0f, fpreal phase=0.0f, fpreal radius=1.0f)
const UT_ColorNode *	getClosestNode (fpreal pos) const
int	getClosestNodeIndex (fpreal pos) const
const UT_ColorNode *	getCurrentNode () const
int	getCurrentNodeIndex () const
void	setCurrentNodeIndex (int i, bool add_to_selection)
void	getColor (fpreal pos, UT_FRGBA *clr, int doInterping=1) const
void	getColor (fpreal pos, float fvals[4], int doInterping=1) const
void	getColor (UT_FRGBA *values, int num, int doInterping=1) const
void	setColorAt (int i, float fvals[4])
void	setColorAt (int i, const UT_FRGBA &clr)
void	setCurrentNodeColor (fpreal32 fvals[4])
void	setCurrentNodeColor (fpreal64 fvals[4])
void	setCurrentNodeColor (const UT_FRGBA &clr)
void	setCurrentNodeBasis (UT_SPLINE_BASIS basis)
void	setNodeBasis (int i, UT_SPLINE_BASIS basis)
void	setEnable (int i, bool enable_pos, bool enable_val, bool enable_interp)
bool	getEnablePos (int i) const
bool	getEnableVal (int i) const
bool	getEnableInterp (int i) const
void	clearSelection ()
bool	isNodeSelected (int i)
void	selectNode (int i, bool add)
void	selectRange (int first_i, int last_i, bool add)
void	deselectNode (int i)
void	toggleSelectNode (int i)
void	getSelectionIndices (UT_IntArray &indices)
void	setSelectionIndices (const UT_IntArray &indices)
void	addNode (fpreal pos)
void	addNode (fpreal pos, fpreal32 fvals[4], UT_SPLINE_BASIS basis=UT_SPLINE_LINEAR)
void	addNode (fpreal pos, fpreal64 fvals[4], UT_SPLINE_BASIS basis=UT_SPLINE_LINEAR)
void	addNode (fpreal pos, const UT_FRGBA &color, UT_SPLINE_BASIS basis=UT_SPLINE_LINEAR)
bool	deleteNode (fpreal pos)
bool	deleteNodeAt (int i)
void	deleteSelectedNodes ()
void	moveNode (const UT_ColorNode *node, fpreal pos)
void	moveNodeSelection (int node_i, fpreal pos)
int	load (const char *pathname)
bool	load (UT_IStream &is)
int	save (const char *pathname) const
int	save (ostream &os) const
UT_Ramp &	operator= (const UT_Ramp &from)
bool	operator== (const UT_Ramp &from) const
void	setRamp (const UT_ColorNode *r, int size)
void	rampLookup (fpreal pos, float values[4]) const
void	rampLookupNoInterp (fpreal pos, float values[4]) const
void	rampLookup (fpreal u0, fpreal u1, float values[4], int ns) const
void	rampLookupNoInterp (fpreal u0, fpreal u1, float values[4], int ns) const
template<typename ARCHIVER_T >
bool	serialize (ARCHIVER_T &archiver)