module::core::axes Class Reference

Provides a configurable set of axes to assist users in visualizing the 3D workspace. More...

Inheritance diagram for module::core::axes:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 axes (k3d::iplugin_factory &Factory, k3d::idocument &Document)
void on_font_changed (k3d::ihint *)
bool grid_target_position (const k3d::point3 &Position, k3d::point3 &TargetPosition)
bool grid_target_orientation (const k3d::point3 &Position, k3d::vector3 &Look, k3d::vector3 &Up)
const k3d::bounding_box3 extents ()
 Returns the bounding box of an object (within its local coordinate system).
k3d::uint_t gl_layer ()
void on_gl_draw (const k3d::gl::render_state &State)
void on_gl_select (const k3d::gl::render_state &State, const k3d::gl::selection_state &SelectState)
void snap (const k3d::point3 &InputCoordinates, k3d::point3 &SnapCoordinates, std::string &SnapDescription)

Static Public Member Functions

static k3d::iplugin_factoryget_factory ()

Private Types

typedef k3d::snappable
< k3d::gl::renderable
< k3d::transformable
< k3d::node > > > 
base

Private Member Functions

 k3d_data (bool, immutable_name, change_signal, with_undo, local_storage, no_constraint, writable_property, with_serialization) m_axes
 Set to true iff the object should be visible in OpenGL viewports.
 k3d_data (bool, immutable_name, change_signal, with_undo, local_storage, no_constraint, writable_property, with_serialization) m_xy_plane
 Set to true iff the object should be visible in OpenGL viewports.
 k3d_data (bool, immutable_name, change_signal, with_undo, local_storage, no_constraint, writable_property, with_serialization) m_yz_plane
 Set to true iff the object should be visible in OpenGL viewports.
 k3d_data (bool, immutable_name, change_signal, with_undo, local_storage, no_constraint, writable_property, with_serialization) m_xz_plane
 Set to true iff the object should be visible in OpenGL viewports.
 k3d_data (double, immutable_name, change_signal, with_undo, local_storage, no_constraint, measurement_property, with_serialization) m_grid_size
 k3d_data (k3d::int32_t, immutable_name, change_signal, with_undo, local_storage, with_constraint, measurement_property, with_serialization) m_grid_count
 k3d_data (k3d::color, immutable_name, change_signal, with_undo, local_storage, no_constraint, writable_property, with_serialization) m_x_color
 k3d_data (k3d::color, immutable_name, change_signal, with_undo, local_storage, no_constraint, writable_property, with_serialization) m_y_color
 k3d_data (k3d::color, immutable_name, change_signal, with_undo, local_storage, no_constraint, writable_property, with_serialization) m_z_color
 k3d_data (k3d::color, immutable_name, change_signal, with_undo, local_storage, no_constraint, writable_property, with_serialization) m_grid_color
 k3d_data (k3d::filesystem::path, immutable_name, change_signal, with_undo, local_storage, no_constraint, path_property, path_serialization) m_font_path
 k3d_data (k3d::double_t, immutable_name, change_signal, with_undo, local_storage, no_constraint, writable_property, with_serialization) m_font_size

Private Attributes

boost::scoped_ptr< FTFont > m_font

Detailed Description

Provides a configurable set of axes to assist users in visualizing the 3D workspace.


Member Typedef Documentation


Constructor & Destructor Documentation

module::core::axes::axes ( k3d::iplugin_factory Factory,
k3d::idocument Document 
) [inline]

Member Function Documentation

const k3d::bounding_box3 module::core::axes::extents (  )  [inline, virtual]

Returns the bounding box of an object (within its local coordinate system).

Implements k3d::ibounded.

static k3d::iplugin_factory& module::core::axes::get_factory (  )  [inline, static]
k3d::uint_t module::core::axes::gl_layer (  )  [inline, virtual]

Returns the layer on which this renderable should be drawn. Lower-numbered layers are rendered earlier than higher-numbered layers. The (arbitrary) default layer for most 3D objects is 1024. Layer zero is reserved for the viewport background.

Reimplemented from k3d::gl::renderable< k3d::transformable< k3d::node > >.

bool module::core::axes::grid_target_orientation ( const k3d::point3 Position,
k3d::vector3 Look,
k3d::vector3 Up 
) [inline]

Referenced by axes().

bool module::core::axes::grid_target_position ( const k3d::point3 Position,
k3d::point3 TargetPosition 
) [inline]

References k3d::round().

Referenced by axes().

module::core::axes::k3d_data ( k3d::double_t  ,
immutable_name  ,
change_signal  ,
with_undo  ,
local_storage  ,
no_constraint  ,
writable_property  ,
with_serialization   
) [private]
module::core::axes::k3d_data ( k3d::filesystem::path  ,
immutable_name  ,
change_signal  ,
with_undo  ,
local_storage  ,
no_constraint  ,
path_property  ,
path_serialization   
) [private]
module::core::axes::k3d_data ( k3d::color  ,
immutable_name  ,
change_signal  ,
with_undo  ,
local_storage  ,
no_constraint  ,
writable_property  ,
with_serialization   
) [private]
module::core::axes::k3d_data ( k3d::color  ,
immutable_name  ,
change_signal  ,
with_undo  ,
local_storage  ,
no_constraint  ,
writable_property  ,
with_serialization   
) [private]
module::core::axes::k3d_data ( k3d::color  ,
immutable_name  ,
change_signal  ,
with_undo  ,
local_storage  ,
no_constraint  ,
writable_property  ,
with_serialization   
) [private]
module::core::axes::k3d_data ( k3d::color  ,
immutable_name  ,
change_signal  ,
with_undo  ,
local_storage  ,
no_constraint  ,
writable_property  ,
with_serialization   
) [private]
module::core::axes::k3d_data ( k3d::int32_t  ,
immutable_name  ,
change_signal  ,
with_undo  ,
local_storage  ,
with_constraint  ,
measurement_property  ,
with_serialization   
) [private]
module::core::axes::k3d_data ( double  ,
immutable_name  ,
change_signal  ,
with_undo  ,
local_storage  ,
no_constraint  ,
measurement_property  ,
with_serialization   
) [private]
module::core::axes::k3d_data ( bool  ,
immutable_name  ,
change_signal  ,
with_undo  ,
local_storage  ,
no_constraint  ,
writable_property  ,
with_serialization   
) [private]

Set to true iff the object should be visible in OpenGL viewports.

Reimplemented from k3d::gl::renderable< k3d::transformable< k3d::node > >.

module::core::axes::k3d_data ( bool  ,
immutable_name  ,
change_signal  ,
with_undo  ,
local_storage  ,
no_constraint  ,
writable_property  ,
with_serialization   
) [private]

Set to true iff the object should be visible in OpenGL viewports.

Reimplemented from k3d::gl::renderable< k3d::transformable< k3d::node > >.

module::core::axes::k3d_data ( bool  ,
immutable_name  ,
change_signal  ,
with_undo  ,
local_storage  ,
no_constraint  ,
writable_property  ,
with_serialization   
) [private]

Set to true iff the object should be visible in OpenGL viewports.

Reimplemented from k3d::gl::renderable< k3d::transformable< k3d::node > >.

module::core::axes::k3d_data ( bool  ,
immutable_name  ,
change_signal  ,
with_undo  ,
local_storage  ,
no_constraint  ,
writable_property  ,
with_serialization   
) [private]

Set to true iff the object should be visible in OpenGL viewports.

Reimplemented from k3d::gl::renderable< k3d::transformable< k3d::node > >.

void module::core::axes::on_font_changed ( k3d::ihint  )  [inline]
void module::core::axes::on_gl_draw ( const k3d::gl::render_state State  )  [inline, virtual]
void module::core::axes::on_gl_select ( const k3d::gl::render_state State,
const k3d::gl::selection_state SelectState 
) [inline, virtual]
void module::core::axes::snap ( const k3d::point3 InputCoordinates,
k3d::point3 SnapCoordinates,
std::string &  SnapDescription 
) [inline]

Member Data Documentation

boost::scoped_ptr<FTFont> module::core::axes::m_font [private]

Referenced by on_font_changed(), and on_gl_draw().


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

Generated on Mon Mar 21 07:43:14 2011 for K-3D by doxygen 1.6.3