GlsEyePoint Class Reference

Inheritance diagram for GlsEyePoint:

Public Types
enum	FovConstraintType {   FOV_CONSTRAINT_NONE ,   FOV_CONSTRAINT_GREATER ,   FOV_CONSTRAINT_LESS ,   FOV_CONSTRAINT_EXACTLY }
Public Types inherited from DisplayObject
enum	MemberAccess_e {   PUBLIC ,   PRIVATE ,   PROTECTED }
enum	PickableType_e {   UNPICKABLE ,   FIRST_PICK ,   BEST_PICK ,   ALWAYS_PICK }
enum	PolygonClose_e {   POLY_OPEN ,   POLY_CLOSED }
enum	PolygonMode_e {   POLY_MODE_UNDEFINED ,   POLY_MODE_POINTS ,   POLY_MODE_OUTLINE ,   POLY_MODE_FILLED ,   POLY_MODE_FILL_AND_OUTLINE }
enum	ShadingType_e {   SHADING_FLAT ,   SHADING_GOURAUD }
enum	TextureMap_e {   TEXTURE_MAP_MODULATE ,   TEXTURE_MAP_DECAL ,   TEXTURE_MAP_BLEND ,   TEXTURE_MAP_REPLACE }
enum	TextureFilter_e {   TEXTURE_FILTER_NEAREST ,   TEXTURE_FILTER_LINEAR ,   TEXTURE_FILTER_NEAREST_MIPMAP_NEAREST ,   TEXTURE_FILTER_LINEAR_MIPMAP_LINEAR ,   TEXTURE_FILTER_NEAREST_MIPMAP_LINEAR ,   TEXTURE_FILTER_LINEAR_MIPMAP_NEAREST }
enum	TessellateType_e {   TESSELLATE_UNION ,   TESSELLATE_INTERSECT ,   TESSELLATE_DIFFERENCE }
enum	RotationAxis_e {   X_AXIS ,   Y_AXIS ,   Z_AXIS }
enum	LineStyle_e {   SOLID_LINE_STYLE ,   SMALL_DOTTED_LINE_STYLE ,   DOTTED_LINE_STYLE ,   DASHED_LINE_STYLE ,   DOT_DASHED_LINE_STYLE ,   SMALL_DASHED_LINE_STYLE }
enum	AlphaMode_e {   ALPHA_MODE_UNDEFINED ,   ALPHA_MODE_OPAQUE ,   ALPHA_MODE_2_LEVEL ,   ALPHA_MODE_256_LEVEL }

Public Member Functions
	GlsEyePoint ()
	GlsEyePoint (GlsEyePoint &src)
None	FOV (float fovDeg)
None	OtherFOV (float fovDeg)
None	FovIsHorizontal (bool val)
None	Orthographic (bool val)
None	OrthoSize (float val)
None	OtherOrthoSize (float val)
None	NearClip (float val)
None	FarClip (float val)
None	HorizontalConstraint (FovConstraintType val)
None	VerticalConstraint (FovConstraintType val)
None	SetViewVectors (Vector &x, Vector &y, Vector &z)
float	FOV (None)
float	OtherFOV (None)
bool	FovIsHorizontal (None)
bool	Orthographic (None)
float	OrthoSize (None)
float	OtherOrthoSize (None)
float	NearClip (None)
float	FarClip (None)
FovConstraintType	HorizontalConstraint (None)
FovConstraintType	VerticalConstraint (None)
None	GetViewVectors (Vector &x, Vector &y, Vector &z)
None	Orientation (Vector &direction, float roll, Vector &upVector=Vector(0, 1, 0))
Vector	Direction (None)
float	Roll (Vector upVector=Vector(0, 1, 0))
Public Member Functions inherited from DisplayObject
bool	isNULL ()
str	GetName ()
str	SetName (str name)
None	SetProtectionMode (DisplayObject::MemberAccess_e mode)
DisplayObject::MemberAccess_e	GetProtectionMode (None)
None	SetLocked (bool val)
bool	GetLocked (None)
bool	GetGenerateMemberVariable ()
None	SetGenerateMemberVariable (bool b)
bool	GetAntiAliasing ()
None	SetAntiAliasing (bool antiAliasing)
bool	GetBlinking ()
None	SetBlinking (bool blinking)
float	GetBlinkRate ()
None	SetBlinkRate (float rate)
int	GetAlphaMode ()
None	SetAlphaMode (int mode)
bool	GetCullBackFaces ()
None	SetCullBackFaces (bool cullFaces)
bool	GetZBufferTestedFlag ()
None	SetZBufferTestedFlag (bool tested)
bool	GetAffectZBufferFlag ()
None	SetAffectZBufferFlag (bool affect)
bool	GetLightingEnabledFlag ()
None	SetLightingEnabledFlag (bool enabled)
DisplayObject::PickableType_e	GetPickMode ()
None	SetPickMode (DisplayObject::PickableType_e mode)
bool	GetVisibilityFlag ()
None	SetVisibilityFlag (bool visible)
PolygonClose_e	GetClosePolygonFlag ()
None	SetClosePolygonFlag (PolygonClose_e closePolygon)
PolygonMode_e	GetPolygonMode ()
None	SetPolygonMode (PolygonMode_e polygonMode)
ShadingType_e	GetShadingMode ()
None	SetShadingMode (ShadingType_e shadingMode)
Vertex	GetLocation ()
None	SetLocation (Vertex loc)
Vertex	GetRotationPoint ()
None	SetRotationPoint (Vertex rotPoint)
GlsMatrixAffine *	GetDcsMatrix ()
None	SetDcsMatrix (GlsMatrixAffine *matrix)
int	GetMaterialIndex ()
None	SetMaterialIndex (int matIndex)
str	GetObjectClassName ()
int	GetTextureIndex ()
None	SetTextureIndex (int texIndex)
TextureMap_e	GetTextureMappingTechnique ()
None	SetTextureMappingTechnique (TextureMap_e mappingTechnique)
bool	GetTextureRepeat ()
None	SetTextureRepeat (bool repeat)
disti::GlsColor	GetBlendingColor ()
None	SetBlendingColor (GlsColor blendColor)
DisplayObject::TextureFilter_e	GetTextureMagnificationFilter ()
None	SetTextureMagnificationFilter (DisplayObject::TextureFilter_e filter)
DisplayObject::TextureFilter_e	GetTextureMinificationFilter ()
None	SetTextureMinificationFilter (DisplayObject::TextureFilter_e filter)
list	GetTextureCoordinates ()
None	SetTextureCoordinates (list &texVerts)
None	GetTextureCoordinates (VertexArray *texVerts)
None	SetTextureCoordinates (VertexArray &texVerts)
None	GetTexturePoints (VertexArray *texVerts)
None	SetTexturePoints (VertexArray &texVerts)
None	SetTexturePoints (list &texVerts)
list	GetTexturePoints ()
None	GetVertices (VertexArray *verts)
None	SetVertices (VertexArray &verts)
str	GetInitialization ()
None	SetInitialization (str initCode)
str	GetCallbackCode ()
None	SetCallbackCode (str cbCode)
DisplayObject *	DuplicateObject (Document *doc=NULL)
DisplayObject *	TessellateObject ()
DisplayObject *	ExtrudeObject (float amount)
None	RotateObject (float amount, RotationAxis_e axis)
None	TranslateObject (float x, float y, float z)
None	ScaleObject (float x, float y, float z, Vertex *anchor=NULL)
None	LineWidth (float width)
float	LineWidth ()
LineStyle_e	LineStyle ()
None	LineStyle (LineStyle_e style)
GlsColor	LineColor ()
None	LineColor (GlsColor color)
GlsColor	FillColor ()
None	FillColor (GlsColor color)
None	GetExtents (Vector &min, Vector &max)
bool	HasUserDefinedAttribute (str attribName)
std::map< str, str >	GetUserDefinedAttributes ()
UserDefinedValueAttributeList	GetAllUserDefinedAttributes ()
str	GetUserDefinedAttributeValue (str attribName)
	typemap (check) str attribName
None	SetUserDefinedAttributeValue (str attribName, str value)
DisplayObject *	GetParent ()
Document *	GetDocument ()
str	AlternateClassName ()
None	AlternateClassName (str name)
str	GetAlternateClassHeaderFile ()
None	SetAlternateClassHeaderFile (str name)
str	GetResources ()
str	GetRuntimeResources (bool recursive)
str	GetAttributeType (str attribName)
str	GetAttributeValuestr (str attribName)
None	SetAttributeValuestr (str attribName, str value)
int	RegisterObserver (str attribName, PyObject *pyfunc)
None	UnregisterObserver (str attribName, int id)
list	GetNormals ()
None	SetNormals (list &normals)
list	GetExtraAttributes ()
DisplayObject *	CloneObject ()
None	CopyProperties (DisplayObject *sourceObj)
None	SetLocation (Vector loc)
GlsMatrixAffine	GetObjectCoordinatesTransform (DisplayObject *targetObject)
None	CalculateParentBoundingBox ()
None	SetOrigin (Vertex &vert)

Static Public Member Functions
static GlsEyePoint *	CastToGlsEyePoint (DisplayObject *obj)

Additional Inherited Members
Static Public Attributes inherited from DisplayObject
static int	TEXTURE_INDEX_NONE = -1

Detailed Description

Class that encapsulates a GlsEyePoint.

Member Enumeration Documentation

FovConstraintType

enum GlsEyePoint::FovConstraintType

Field-of-View Constraint Type enumeration.

Enumerator
FOV_CONSTRAINT_NONE
FOV_CONSTRAINT_GREATER
FOV_CONSTRAINT_LESS
FOV_CONSTRAINT_EXACTLY

Constructor & Destructor Documentation

GlsEyePoint() [1/2]

GlsEyePoint::GlsEyePoint

(

)

Constructor.

Creates a new GlsEyePoint.

GlsEyePoint() [2/2]

GlsEyePoint::GlsEyePoint

(

GlsEyePoint &

src

)

Copy ructor.

Creates a new reference to an existing GlsEyePoint.

Parameters

src	The GlsEyePoint to reference

Member Function Documentation

CastToGlsEyePoint()

static GlsEyePoint * GlsEyePoint::CastToGlsEyePoint ( DisplayObject *  obj )

static

Casts a display object to an eyepoint.

Parameters

obj	The display object to cast.

Direction()

Vector GlsEyePoint::Direction

(

None

)

Gets the current direction vector of the eyepoint.

Returns

The current view direction vector

FarClip() [1/2]

None GlsEyePoint::FarClip

(

float

val

)

Sets the distance to the far clipping plane from the eyepoint.

Parameters

val	Distance to the far clipping plane from the eyepoint in logical units

FarClip() [2/2]

float GlsEyePoint::FarClip

(

None

)

Gets the distance to the far clipping plane from the eyepoint.

Returns

Distance to the far clipping plane from the eyepoint in logical units

FOV() [1/2]

None GlsEyePoint::FOV

(

float

fovDeg

)

Sets the Field Of View for this eyepoint.

If FovIsHorizontal is True, this is the horizontal fov.

Parameters

fovDeg

The new field of view, in degrees

FOV() [2/2]

float GlsEyePoint::FOV

(

None

)

Gets the Field Of View for this eyepoint.

If FovIsHorizontal is true, this is the horizontal fov.

Returns

The field of view, in degrees

FovIsHorizontal() [1/2]

None GlsEyePoint::FovIsHorizontal

(

bool

val

)

Sets whether or not the field of view measurement is along horizontal or vertical axis.

Parameters

val	True if FOV measurement is along horizonal axis of eyepoint

FovIsHorizontal() [2/2]

bool GlsEyePoint::FovIsHorizontal

(

None

)

Gets whether or not the field of view measurement is along horizontal or vertical axis.

Returns

True if FOV measurement is along horizonal axis of eyepoint

GetViewVectors()

None GlsEyePoint::GetViewVectors	(	Vector &	x,
		Vector &	y,
		Vector &	z
	)

Returns the current view vectors.

Parameters

[out]	x	The current x-direction vector
[out]	y	The current y-direction vector
[out]	z	The current z-direction vector

HorizontalConstraint() [1/2]

None GlsEyePoint::HorizontalConstraint

(

FovConstraintType

val

)

Sets the raint for the horizontal direction.

Parameters

val	The type of raint to use for the horizontal field of view

HorizontalConstraint() [2/2]

FovConstraintType GlsEyePoint::HorizontalConstraint

(

None

)

Gets the raint for the horizontal direction.

Returns

The type of raint used for the horizontal field of view

NearClip() [1/2]

None GlsEyePoint::NearClip

(

float

val

)

Sets the distance to the near clipping plane from the eyepoint.

Parameters

val	Distance to the near clipping plane from the eyepoint in logical units

NearClip() [2/2]

float GlsEyePoint::NearClip

(

None

)

Gets the distance to the near clipping plane from the eyepoint.

Returns

Distance to the near clipping plane from the eyepoint in logical units

Orientation()

None GlsEyePoint::Orientation	(	Vector &	direction,
		float	roll,
		Vector &	upVector = Vector(0, 1, 0)
	)

Sets the orientation of the eyepoint.

Parameters

direction	The view direction vector
roll	The roll value about the direction vector, in degrees
upVector	The "up" direction for the purposes of calculating roll

Orthographic() [1/2]

None GlsEyePoint::Orthographic

(

bool

val

)

Sets whether the eyepoint uses an orthographic projection or a perspective projection.

Parameters

val	True if the eypoint uses an orthographic projection. False if it uses a perspective projection.

Orthographic() [2/2]

bool GlsEyePoint::Orthographic

(

None

)

Gets whether the eyepoint uses an orthographic projection or a perspective projection.

Returns

True if the eypoint uses an orthographic projection. False if it uses a perspective projection.

OrthoSize() [1/2]

None GlsEyePoint::OrthoSize

(

float

val

)

Sets the size of the orthographic projection, in logical units.

The direction this controls is set by FovIsHorizontal. If true, it is horizontal.

Parameters

val	The size of the orthographic projection, in logical units

OrthoSize() [2/2]

float GlsEyePoint::OrthoSize

(

None

)

Gets the size of the orthographic projection, in logical units.

The direction this returns is set by FovIsHorizontal. If true, it is horizontal.

Returns

The size of the orthographic projection, in logical units

OtherFOV() [1/2]

None GlsEyePoint::OtherFOV

(

float

fovDeg

)

Sets the Field Of View for this eyepoint.

If FovIsHorizontal is True, this is the vertical fov.

Parameters

fovDeg

The new field of view, in degrees

OtherFOV() [2/2]

float GlsEyePoint::OtherFOV

(

None

)

Gets the Field Of View for this eyepoint.

If FovIsHorizontal is true, this is the vertical fov.

Returns

The field of view, in degrees

OtherOrthoSize() [1/2]

None GlsEyePoint::OtherOrthoSize

(

float

val

)

Sets the size of the orthographic projection, in logical units.

The direction this controls is set by FovIsHorizontal. If true, it is vertical.

Parameters

val	The size of the orthographic projection, in logical units

OtherOrthoSize() [2/2]

float GlsEyePoint::OtherOrthoSize

(

None

)

Gets the size of the orthographic projection, in logical units.

The direction this returns is set by FovIsHorizontal. If true, it is vertical.

Returns

The size of the orthographic projection, in logical units

Roll()

float GlsEyePoint::Roll

(

Vector

upVector = Vector(0, 1, 0)

)

Gets the current roll angle of the eyepoint.

Parameters

upVector

The "up" direction used for determining roll

Returns

The current roll angle, in degrees

SetViewVectors()

None GlsEyePoint::SetViewVectors	(	Vector &	x,
		Vector &	y,
		Vector &	z
	)

Directly sets the view vectors.

These are normally controlled by the Orientation call.

Parameters

x	The x-direction view vector
y	The y-direction view vector
z	The z-direction view vector

VerticalConstraint() [1/2]

None GlsEyePoint::VerticalConstraint

(

FovConstraintType

val

)

Sets the raint for the vertical direction.

Parameters

val	The type of raint to use for the vertical field of view

VerticalConstraint() [2/2]

FovConstraintType GlsEyePoint::VerticalConstraint

(

None

)

Gets the raint for the vertical direction.

Returns

The type of raint used for the vertical field of view

---

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

• GlsEyePoint.i