cee::vis::PlaneLocator Class Reference

A locator designed to position a plane. More...

Public Member Functions

 PlaneLocator (View *view)
 Creates a plane locator for the given view. More...
 
void setup (const Vec3d &point, const Vec3d &normal)
 Sets the initial point and normal for the plane locator. More...
 
Vec3d point () const
 Returns the updated plane locator point. More...
 
void setPoint (const Vec3d &point)
 Sets the plane locator point. More...
 
Vec3d normal () const
 Returns the updated plane locator normal. More...
 
void setMaximumExtent (double maxExtent)
 Sets the maximum extent of the plane. More...
 
double maximumExtent () const
 Returns the updated plane locator extent. More...
 
Color3f planeColor () const
 Returns the color of the locator surface plane. More...
 
void setPlaneColor (const Color3f &color)
 Sets the color of the locator surface plane. More...
 
void setPlaneOpacity (float opacity)
 Sets the opacity of the locator plane. More...
 
float planeOpacity () const
 Returns the opacity of the locator plane. More...
 
Color3f centerPointColor () const
 Returns the color of the sphere indicating the locators rotation point. More...
 
void setCenterPointColor (const Color3f &color)
 Sets the color of the sphere indicating the locators rotation point. More...
 
Color3f arrowColor () const
 Returns the color of the sphere indicating the locators rotation point. More...
 
void setArrowColor (const Color3f &color)
 Sets the color of the arrow indicating the locators normal. More...
 
bool surfaceVisible () const
 Returns the plane surface visibility. More...
 
void setSurfaceVisible (bool visible)
 Sets the plane surface visibility. More...
 
bool borderVisible () const
 Returns the plane border visibility. More...
 
void setBorderVisible (bool visible)
 Sets the plane border visibility. More...
 
void planeNavigationOnMousePressEvent (MouseEvent *mouseEvent, const Vec3d &rotationPoint)
 Processes mouse press event. More...
 
void planeNavigationOnMouseMoveEvent (MouseEvent *mouseEvent)
 Processes mouse move event. More...
 
void planeNavigationOnMouseReleaseEvent (MouseEvent *mouseEvent)
 Processes mouse release event. More...
 
- Public Member Functions inherited from cee::vis::MarkupModel
 MarkupModel ()
 Creates empty markup model. More...
 
size_t partCount () const
 Returns the number of parts in the model. More...
 
size_t partIndex (MarkupPart *part) const
 Returns the index of the specified part. More...
 
MarkupPartpart (size_t index)
 Returns the part at the given index. More...
 
const MarkupPartpart (size_t index) const
 Returns a const pointer to the part at the given index. More...
 
void addPart (MarkupPart *part)
 Adds the part to the model. More...
 
void removePart (MarkupPart *part)
 Removes the specified part from the model. More...
 
void removeAllParts ()
 Removes all parts from the model. More...
 
virtual BoundingBox boundingBox ()
 Returns the current bounding box of the model. More...
 
virtual Str modelInfo () const
 Returns information about the model. More...
 
size_t rayIntersect (const Ray &ray, const View &view)
 Returns the index of the part hit by the ray. More...
 
bool rayIntersect (const Ray &ray, const View &view, MarkupModelHitItem *hitItem)
 Performs a ray intersect on the parts in the model. More...
 
bool rayIntersectAllHits (const Ray &ray, const View &view, MarkupModelHitItemCollection *hitItems)
 Performs a ray intersect on the parts in the model, returning all parts that was intersected by the ray. More...
 
bool isViewClippingIgnored () const
 Returns true if this model is configured to ignore view clipping. More...
 
void setIgnoreViewClipping (bool ignore)
 Set if view clipping should be ignored for all parts in this model. More...
 
- Public Member Functions inherited from cee::vis::Model
 Model ()
 Constructs an empty model. More...
 
Str name () const
 Returns the name of the model. More...
 
void setName (const Str &name)
 Sets the name of the model. More...
 
bool use2dPixelProjection () const
 Returns true if the model is using a 2D pixel exact projection to render its content. More...
 
void setUse2dPixelProjection (bool use2dMode)
 Specify if this model should use an override camera to render 2D sceen aligned data. More...
 
- Public Member Functions inherited from cee::RefCountedObject
void addRef () const
 Increments the reference count for this object. More...
 
void release () const
 Decrements the reference count for this object. More...
 
int refCount () const
 Returns the reference count for this object. More...
 
void setRefCountZero () const
 Sets the ref count to zero, but DOES NOT delete the object. More...
 

Additional Inherited Members

- Protected Types inherited from cee::vis::Model
enum  NotifyAction { NO_ACTION, MODEL_CHANGED }
 Notification sent to the view. More...
 
- Protected Member Functions inherited from cee::vis::Model
void notifyObservingViews (NotifyAction notifyAction, const View *exceptView)
 Sends a notification to all observing views. More...
 
bool hasAnyObservingViewsWithClipping (bool *outExplicitViewClippingIsActive=NULL, bool *outDropShadowClippingIsActive=NULL) const
 Returns true if the model is a being viewed in any views where clipping is enabled (either view clipping or shadow clipping) More...
 
Inheritance diagram for cee::vis::PlaneLocator:
cee::vis::MarkupModel cee::vis::Model cee::RefCountedObject

Detailed Description

A locator designed to position a plane.

It has custom drawing (draws the plane, point and normal) and also handles panning so that the panning is done in the plane.

Constructor & Destructor Documentation

cee::vis::PlaneLocator::PlaneLocator ( View view)

Creates a plane locator for the given view.

Member Function Documentation

cee::Color3f cee::vis::PlaneLocator::arrowColor ( ) const

Returns the color of the sphere indicating the locators rotation point.

bool cee::vis::PlaneLocator::borderVisible ( ) const

Returns the plane border visibility.

cee::Color3f cee::vis::PlaneLocator::centerPointColor ( ) const

Returns the color of the sphere indicating the locators rotation point.

double cee::vis::PlaneLocator::maximumExtent ( ) const

Returns the updated plane locator extent.

If maximum extent has not been set directly by calling setMaximumExtent(), the extent will be calculated from the views bounding box and this funtion returns cee::UNDEFINED_DOUBLE.

cee::Vec3d cee::vis::PlaneLocator::normal ( ) const

Returns the updated plane locator normal.

cee::Color3f cee::vis::PlaneLocator::planeColor ( ) const

Returns the color of the locator surface plane.

void cee::vis::PlaneLocator::planeNavigationOnMouseMoveEvent ( MouseEvent mouseEvent)

Processes mouse move event.

void cee::vis::PlaneLocator::planeNavigationOnMousePressEvent ( MouseEvent mouseEvent,
const Vec3d rotationPoint 
)

Processes mouse press event.

void cee::vis::PlaneLocator::planeNavigationOnMouseReleaseEvent ( MouseEvent mouseEvent)

Processes mouse release event.

float cee::vis::PlaneLocator::planeOpacity ( ) const

Returns the opacity of the locator plane.

cee::Vec3d cee::vis::PlaneLocator::point ( ) const

Returns the updated plane locator point.

void cee::vis::PlaneLocator::setArrowColor ( const Color3f color)

Sets the color of the arrow indicating the locators normal.

void cee::vis::PlaneLocator::setBorderVisible ( bool  visible)

Sets the plane border visibility.

void cee::vis::PlaneLocator::setCenterPointColor ( const Color3f color)

Sets the color of the sphere indicating the locators rotation point.

void cee::vis::PlaneLocator::setMaximumExtent ( double  maxExtent)

Sets the maximum extent of the plane.

If not set (or set to cee::UNDEFINED_DOUBLE), the extent will be calculated based on the bounding box of the view.

void cee::vis::PlaneLocator::setPlaneColor ( const Color3f color)

Sets the color of the locator surface plane.

void cee::vis::PlaneLocator::setPlaneOpacity ( float  opacity)

Sets the opacity of the locator plane.

void cee::vis::PlaneLocator::setPoint ( const Vec3d point)

Sets the plane locator point.

void cee::vis::PlaneLocator::setSurfaceVisible ( bool  visible)

Sets the plane surface visibility.

void cee::vis::PlaneLocator::setup ( const Vec3d point,
const Vec3d normal 
)

Sets the initial point and normal for the plane locator.

bool cee::vis::PlaneLocator::surfaceVisible ( ) const

Returns the plane surface visibility.