xsi_toolcontext.h

Go to the documentation of this file.

//*****************************************************************************
//*****************************************************************************

#if (_MSC_VER > 1000) || defined(SGI_COMPILER)
#pragma once
#endif

#ifndef __XSITOOLCONTEXT_H__
#define __XSITOOLCONTEXT_H__

#include <xsi_context.h>
#include <xsi_line.h>
#include <xsi_plane.h>
#include <xsi_image.h>
#include <xsi_camera.h>
#include <xsi_kinematicstate.h>
#include <xsi_pickbuffer.h>

namespace XSI {

//*****************************************************************************
//*****************************************************************************

class SICPPSDKDECL ToolContext : public Context
{
public:
    ToolContext();

    ~ToolContext();

    ToolContext(const CRef& in_ref);

    ToolContext(const ToolContext& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    ToolContext& operator=(const ToolContext& in_obj);

    ToolContext& operator=(const CRef& in_ref);

    //*****************************************************************************

    CStatus GetMousePosition( LONG &x, LONG &y ) const;

    bool IsLeftButtonDown() const;

    bool IsMiddleButtonDown() const;

    bool IsRightButtonDown() const;

    bool IsDoubleClick() const;

    bool IsShiftKeyDown() const;

    bool IsControlKeyDown() const;

    CStatus RegisterShortcutKey( ULONG in_virtualKeycode, const CString &in_description, ULONG in_modifiers = 0, bool in_repeats = false );

    CStatus UnRegisterShortcutKey( ULONG in_virtualKeycode, ULONG in_modifiers = 0 );
    bool IsShortcutKeyDown( ULONG in_virtualKeycode, ULONG in_modifiers = 0 ) const;

    ULONG GetShortcutKey() const;

    ULONG GetShortcutKeyModifiers() const;
    //*****************************************************************************

    CStatus GetViewSize( LONG &width, LONG &height ) const;

    CStatus GetViewport( LONG &x, LONG &y, LONG &width, LONG &height ) const;

    bool IsInteracting() const;

    bool IsActiveView() const;

    bool IsNavigating() const;

    LONG GetViewIndex() const;

    Camera GetCamera() const;

    //*****************************************************************************

    CStatus SetCursor( siToolCursor in_cursorId );

    CStatus SetToolDescription( const CString &in_message );

    CStatus EnableSnapping( bool in_enable );

    CStatus GetViewPlane( MATH::CPlane &out_plane ) const;

    CStatus GetGridPlane( MATH::CPlane &out_plane ) const;

    CStatus SetManipulationPlane( const MATH::CPlane &in_plane );

    CStatus ClearManipulationPlane();

    bool WasAborted() const;

    CStatus ExitTool();

    bool GetFlag( LONG in_flag ) const;

    CStatus SetFlag( LONG in_flag, bool in_enable );

    CStatus GetWorldPosition( LONG x, LONG y, MATH::CVector3 &out_world ) const;

    CStatus GetWorldRay( LONG x, LONG y, MATH::CLine &out_ray ) const;

    CStatus WorldToView( const MATH::CVector3 &in_world, MATH::CVector3 &out_view ) const;

    CStatus ViewToWorld( const MATH::CVector3 &in_view, MATH::CVector3 &out_world ) const;

    CStatus WorldToCamera( const MATH::CVector3 &in_world, MATH::CVector3 &out_camera ) const;

    CStatus CameraToWorld( const MATH::CVector3 &in_view, MATH::CVector3 &out_world ) const;

    CStatus GetWorldToViewMatrix( MATH::CMatrix4 &out_worldToView ) const;

    CStatus GetWorldToCameraMatrix( MATH::CMatrix4 &out_worldToCamera ) const;

    CStatus Redraw( bool in_allViews = true );

    CStatus DrawTextString( const CString &in_str, siAlignment in_hPos = siLeftAlign, siAlignment in_vPos = siBottomAlign );

    CStatus GetTextSize( const CString &in_str, LONG &out_width, LONG &out_height, LONG &out_descent ) const;

    CStatus EditTextString( CString &io_str, LONG x, LONG y, LONG width, LONG height );

    CStatus BeginViewDraw();

    CStatus EndViewDraw();

    bool IsViewDraw() const;

    CStatus BeginPickDraw( LONG x, LONG y, LONG width, LONG height);

    CStatus EndPickDraw();

    bool IsPickDraw() const;
    //*****************************************************************************

    CStatus BeginParameterUpdate(const Parameter &in_param, double in_time = DBL_MAX);

    CStatus UpdateParameter(const Parameter &in_param, const CValue &in_value);

    CStatus EndParameterUpdate(const Parameter &in_param);

    CStatus BeginKinematicStateUpdate(const KinematicState &in_kine, double in_time = DBL_MAX);

    CStatus UpdateKinematicState(const KinematicState &in_kine, const MATH::CTransformation &in_value);

    CStatus EndKinematicStateUpdate(const KinematicState &in_kine);

    CStatus BeginTransformUpdate(const CRefArray &in_objects, double in_time = DBL_MAX);

    CStatus UpdateTransform(
        const CRefArray &               in_objects,
        const MATH::CTransformation &   in_value,
        siTransformFilter               in_srt,
        siRefMode                       in_refMode      = siLocal,
        siDeltaMode                     in_delta        = siRelative,
        siAxesFilter                    in_axesFilter   = siXYZ,
        bool                            in_usePivot     = false,
        const MATH::CVector3 &          in_pivot        = MATH::CVector3(),
        const MATH::CTransformation &   in_reference    = MATH::CTransformation()
    );

    CStatus EndTransformUpdate(const CRefArray &in_objects);
    //*****************************************************************************

    siSnapType GetSnapType() const;

    CRef GetSnapObject() const;

    CRef GetSnapComponent() const;

    CStatus Snap( LONG x, LONG y, LONG size, ULONG in_snaptype, const CStringArray& in_families, const CRefArray &in_objects, MATH::CVector3 &out_world ) const;
    //*****************************************************************************

    CStatus Pick( const CLongArray &in_points, siPickMode in_pickMode, siPickType in_pickType, const CString &in_filter, const CRefArray &in_objects, CRefArray &out_picked ) const;

    PickBuffer GetPickBuffer( LONG x, LONG y, LONG width, LONG height, const CString &in_filter, const CRefArray &in_objects, siViewMode in_viewMode = siShaded ) const;
    //*****************************************************************************

    CStatus ShowContextMenu( LONG x, LONG y, siAlignment in_hPos = siLeftAlign, siAlignment in_vPos = siTopAlign );
    //*****************************************************************************

    Image LoadImageFromFile( const CString &in_filename, bool in_relativePath = true );
private:
    ToolContext * operator&() const;
    ToolContext * operator&();
};

};
#endif // __XSITOOLCONTEXT_H__