Vector3D Class Reference

This object is mainly intended for in-Python script usage, since its faster to receive this and directly access its members, than validate python objects from lists. More...

#include <ecgeometry.h>

Inheritance diagram for Vector3D:

EclipseObject

List of all members.

Public Member Functions

 Vector3D ()
 Default.
 Vector3D (float a_fX, float a_fY, float a_fZ)
 By component.
 Vector3D (const YRPoint3D &a_point3D)
 By copy from a yafaray point.
 ~Vector3D ()
 Default.
void Normalize ()
 Normalize Normalizes the components of this vector.
virtual PYOBJECT PyAsString ()
 Python text representation method This function must be implemented by all children.
float * GetComponentsPtr ()
 Access all of our components as an array.
void SetComponents (float *a_pValues)
 Set all of our values by passing a pointer to a 3-float array.
float & x ()
 Return the x component.
float & y ()
 Return the y component.
float & z ()
 Return the z component.
const YRPoint3DAsYRPoint3D () const
 Our contents as YRPoint.

Static Public Member Functions

static bool PyTypeCheck (PYOBJECT a_pObject)
 Python type check Verifies that the provided python object encapsulates our class.

Protected Member Functions

virtual void DeleteObject ()
 Child message hook for reference-count based destruction.


Detailed Description

This object is mainly intended for in-Python script usage, since its faster to receive this and directly access its members, than validate python objects from lists.

A vector composed of 3 floating point values.

Author:
Dan Torres 2008/12/11

Definition at line 42 of file ecgeometry.h.


Member Function Documentation

virtual void Vector3D::DeleteObject (  )  [protected, virtual]

Child message hook for reference-count based destruction.

The child class is responsible for deleting any instance to which this this function is called.

Reimplemented from EclipseObject.

virtual PYOBJECT Vector3D::PyAsString (  )  [virtual]

Python text representation method This function must be implemented by all children.

Returns:
A python string object with a description of ourselves

Reimplemented from EclipseObject.

static bool Vector3D::PyTypeCheck ( PYOBJECT  a_pObject  )  [static]

Python type check Verifies that the provided python object encapsulates our class.

Returns:
True if the provided object type is the same as ours

Reimplemented from EclipseObject.

void Vector3D::SetComponents ( float *  a_pValues  ) 

Set all of our values by passing a pointer to a 3-float array.

Parameters:
a_pValues An array of at least 3 floating point values


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

Generated on Tue Jan 20 17:58:01 2009 for EclipseRay by  doxygen 1.5.7.1