GfxObjBase Class Reference

main interface for all graphic objects, both in C++ and Python More...

#include <gfx_object_base.hh>

Inherits ost::gfx::GfxNode.

Inherited by GfxObj.

Public Member Functions
	GfxObjBase (const String &name)
virtual void	SetMatAmb (const Color &c)=0
virtual void	SetMatDiff (const Color &c)=0
virtual void	SetMatSpec (const Color &c)=0
virtual void	SetMatShin (float s)=0
virtual void	SetMatEmm (const Color &c)=0
virtual void	ContextSwitch ()=0
virtual void	SetRenderMode (RenderMode::Type m)=0
virtual RenderMode::Type	GetRenderMode () const =0
virtual geom::Vec3	GetCenter () const =0
virtual void	SetLineWidth (float w)=0
virtual void	SetPolyMode (unsigned int m)=0
virtual void	SetAALines (bool f)=0
virtual void	SetLineHalo (float f)=0
virtual void	SetOutline (bool f)=0
virtual bool	GetOutline () const =0
virtual void	SetOutlineMode (int m)=0
virtual int	GetOutlineMode () const =0
virtual void	SetOutlineWidth (float f)=0
virtual float	GetOutlineWidth () const =0
virtual void	SetOutlineExpandFactor (float f)=0
virtual float	GetOutlineExpandFactor () const =0
virtual void	SetOutlineExpandColor (const Color &c)=0
virtual Color	GetOutlineExpandColor () const =0
virtual void	SetOpacity (float f)=0
virtual float	GetOpacity () const =0
virtual void	SetSolid (bool f)=0
virtual bool	GetSolid () const =0
virtual void	SetSolidColor (const Color &c)=0
virtual Color	GetSolidColor () const =0
virtual void	SetClip (bool f)=0
virtual bool	GetClip () const =0
virtual void	SetClipPlane (const geom::Vec4 &)=0
virtual geom::Vec4	GetClipPlane () const =0
virtual void	SetClipOffset (float f)=0
virtual float	GetClipOffset () const =0
virtual void	ColorBy (const mol::EntityView &ev, const String &prop, const Gradient &g, float minv, float maxv)=0
virtual void	ColorBy (const img::MapHandle &mh, const String &prop, const Gradient &g, float minv, float maxv)=0

---

Detailed Description

main interface for all graphic objects, both in C++ and Python

Definition at line 53 of file gfx_object_base.hh.

---

Constructor & Destructor Documentation

GfxObjBase

(

const String &

name

)

[inline]

Definition at line 56 of file gfx_object_base.hh.

---

Member Function Documentation

virtual void ColorBy	(	const img::MapHandle &	mh,
		const String &	prop,
		const Gradient &	g,
		float	minv,
		float	maxv
	)			[pure virtual]

color based on image

Implemented in Entity, GfxObj, and Surface.

virtual void ColorBy	(	const mol::EntityView &	ev,
		const String &	prop,
		const Gradient &	g,
		float	minv,
		float	maxv
	)			[pure virtual]

color each component based on the gradient-mapped property of the given entity

Implemented in Entity, GfxObj, and Surface.

virtual void ContextSwitch

(

)

[pure virtual]

rendering context switch, some things need to be regenerated

Reimplemented from GfxNode.

Implemented in GfxObj.

virtual geom::Vec3 GetCenter

(

)

const [pure virtual]

get geometric center

Implemented in GfxObj, GfxTestObj, MapIso, MapSlab, and PrimList.

virtual bool GetClip

(

)

const [pure virtual]

Implemented in GfxObj.

virtual float GetClipOffset

(

)

const [pure virtual]

Implemented in GfxObj.

virtual geom::Vec4 GetClipPlane

(

)

const [pure virtual]

Implemented in GfxObj.

virtual float GetOpacity

(

)

const [pure virtual]

returns a value smaller than 1.0 if transparency is used in this object

Implemented in Entity, and GfxObj.

virtual bool GetOutline

(

)

const [pure virtual]

get state of outline rendering

Implemented in GfxObj.

virtual Color GetOutlineExpandColor

(

)

const [pure virtual]

get current outline color (mode 3)

Implemented in GfxObj.

virtual float GetOutlineExpandFactor

(

)

const [pure virtual]

get current outline expand factor (mode 3)

Implemented in GfxObj.

virtual int GetOutlineMode

(

)

const [pure virtual]

get current outline mode

Implemented in GfxObj.

virtual float GetOutlineWidth

(

)

const [pure virtual]

get current outline width

Implemented in GfxObj.

virtual RenderMode::Type GetRenderMode

(

)

const [pure virtual]

current render mode

Implemented in GfxObj.

virtual bool GetSolid

(

)

const [pure virtual]

Implemented in GfxObj.

virtual Color GetSolidColor

(

)

const [pure virtual]

Implemented in GfxObj.

virtual void SetAALines

(

bool

f

)

[pure virtual]

turn on sophisticated line anti-aliasing, requires shader

Implemented in GfxObj.

virtual void SetClip

(

bool

f

)

[pure virtual]

Implemented in GfxObj.

virtual void SetClipOffset

(

float

f

)

[pure virtual]

Implemented in Entity, and GfxObj.

virtual void SetClipPlane

(

const geom::Vec4 &

)

[pure virtual]

Implemented in GfxObj.

virtual void SetLineHalo

(

float

f

)

[pure virtual]

turn on line halo of given strength

Implemented in GfxObj.

virtual void SetLineWidth

(

float

w

)

[pure virtual]

set line width

Implemented in GfxObj, and PrimList.

virtual void SetMatAmb

(

const Color &

c

)

[pure virtual]

material ambient color

Implemented in GfxObj.

virtual void SetMatDiff

(

const Color &

c

)

[pure virtual]

material diffuse color

Implemented in GfxObj.

virtual void SetMatEmm

(

const Color &

c

)

[pure virtual]

material emmissive color

Implemented in GfxObj.

virtual void SetMatShin

(

float

s

)

[pure virtual]

material shininess

Implemented in GfxObj.

virtual void SetMatSpec

(

const Color &

c

)

[pure virtual]

material specular color

Implemented in GfxObj.

virtual void SetOpacity

(

float

f

)

[pure virtual]

set opacity (1 = no transparency)

Implemented in Entity, and GfxObj.

virtual void SetOutline

(

bool

f

)

[pure virtual]

turn outline rendering on or off

Implemented in GfxObj.

virtual void SetOutlineExpandColor

(

const Color &

c

)

[pure virtual]

set outline color (mode 3)

Implemented in Entity, and GfxObj.

virtual void SetOutlineExpandFactor

(

float

f

)

[pure virtual]

set outline expansion factor (mode 3) this scales with resolution

Implemented in Entity, and GfxObj.

virtual void SetOutlineMode

(

int

m

)

[pure virtual]

set outline mode, 1, 2 or 3

Implemented in GfxObj.

virtual void SetOutlineWidth

(

float

f

)

[pure virtual]

set outline width in pixels (modes 1 + 2) this does not scale with resolution

Implemented in Entity, and GfxObj.

virtual void SetPolyMode

(

unsigned int

m

)

[pure virtual]

set polygon mode

Implemented in GfxObj.

virtual void SetRenderMode

(

RenderMode::Type

m

)

[pure virtual]

change render mode

Implemented in Entity, and GfxObj.

virtual void SetSolid

(

bool

f

)

[pure virtual]

Implemented in GfxObj.

virtual void SetSolidColor

(

const Color &

c

)

[pure virtual]

Implemented in GfxObj.

---

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

• stage/include/ost/gfx/gfx_object_base.hh