All Frameworks Class Hierarchy This Framework Previous Next Indexes
VisualizationBase Class CAT3DViewpoint
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---System.CATEventSubscriber
|
+---VisualizationBase.CATViewpoint
|
+---CAT3DViewpoint
Usage: you must use this class as is. You should never derive it.
public class CAT3DViewpoint
Class that represents the way the 3D scene is seen.
Constructor and Destructor Index
- o
CAT3DViewpoint()
- Creates a non-initialized viewpoint.
- o
CAT3DViewpoint(CAT3DViewpoint&)
- Creates a new viewpoint by copying geometrical values.
- o
CAT3DViewpoint(CATMathPointf&,CATMathDirectionf&,CATMathDirectionf&,float,float,CATProjectionType,float)
- Creates a new viewpoint from its main characteristics.
Method Index
- o
AddFurtiveRep(CAT3DRep*)
- Adds a furtive representation in the scene the observator may seen.
- o
AddRep(CAT3DRep*)
- Adds a representation in the scene the observator may seen.
- o
ComputeModelFromPixel(float,float,CATMathPointf&,CATMathPointf&,float,float,float,float)
- Computes the line of indication from a pixel position on the window.
- o
GetBoundingSphere()
- Gets the bounding sphere of all non-furtive representation of the scene.
- o
GetFocusDistance()
- Gets the focus distance.
- o
GetGravityDirection()
- Sets the gravity direction.
- o
GetGravityMode()
- Gets the gravity mode .
- o
GetOrigin()
- Gets viewpoint eye position.
- o
GetProjectionType()
- Gets the type of projection on the window.
- o
GetSightDirection()
- Gets viewpoint sight.
- o
GetTarget()
- Gets the target location.
- o
GetUpDirection()
- Gets viewpoint up.
- o
Is3D()
- Retrieves whether viewpoint is a three dimensional one or not.
- o
Reframe(float,float,float,float)
- Reframes the model in the window.
- o
Reframe(float,float,float,float,CAT3DBoundingSphere&)
- Reframes the model in the window.
- o
RemoveFurtiveRep(CAT3DRep*)
- Removes the representation from the furtive list.
- o
RemoveRep(CAT3DRep*)
- Removes the representation from the furtive list.
- o
Set(CATMathPointf&,CATMathDirectionf&,CATMathDirectionf&)
- Sets viewpoint location (main characteristics).
- o
SetFocus(float&)
- Sets the focus distance.
- o
SetGravityDirection(CATMathDirectionf&)
- Sets the gravity direction.
- o
SetGravityMode(CATViewpointGravityMode)
- Sets the gravity mode .
- o
SetOrigin(CATMathPointf&)
- Sets viewpoint eye position.
- o
SetProjectionType(CATProjectionType)
- Sets the type of projection.
- o
SetSightDirection(CATMathDirectionf&)
- Sets viewpoint sight.
- o
SetTarget(CATMathPointf&)
- Sets the Target.
- o
SetUpDirection(CATMathDirectionf&)
- Sets viewpoint up.
- o
operator =(CAT3DViewpoint&)
- Copies the geometric definition of a CAT3DViewpoint.
Constructor and Destructor
o CAT3DViewpoint
-
Creates a non-initialized viewpoint.
At the first display (when the viewer will appears)
a reframe will automatically been done on the viewpoint.
o CAT3DViewpoint
-
Creates a new viewpoint by copying geometrical values.
- Eye position and orientation (Origin, SightDirection, UpDirection)
- other characteristics (Angle, Focus, ProjectionType, ProjectionDirection)
- Dynamic behaviour (Gravity mode, Clipping planes mode)
o CAT3DViewpoint
-
Creates a new viewpoint from its main characteristics.
- Parameters:
-
- iEye
- Position of the Eye
- iSight
- Sight Direction (Direction where the observator looks at)
- iUp
- Up direction (Direction of the observator head's top)
- iNearDistance
- Distance from the Eye to the near clipping plane
- iFarDistance
- Distance from the Eye to the far clipping plane
- iProjectionType
- The Projection type
- iFocusDistance
- The distance from the Eye to the target
Methods
o AddFurtiveRep
-
Adds a furtive representation in the scene the observator may seen.
Pixels of Furtive representations may not be in the expected color but can
be displayed and hidden without re-drawind the whole scene. Must be used for
temporary displays
- Parameters:
-
- iRep
- Representation 3D
o AddRep
-
Adds a representation in the scene the observator may seen.
- Parameters:
-
- iRep
- Representation 3D
o ComputeModelFromPixel
public virtual void ComputeModelFromPixel( | const float | iX, |
| const float | iY, |
| CATMathPointf& | oNearPoint, |
| CATMathPointf& | oFarPoint, |
| const float | iWidth, |
| const float | iHeight, |
| const float | mmInSupportUnit, |
| const float | ratioWH) |
-
Computes the line of indication from a pixel position on the window.
- Parameters:
-
- iX
- Position in X of the point (pixel coordinates : x=0 left window)
- iY
- Position in Y of the point (pixel coordinates : y=0 top of window)
- oNearPoint
- Returns the nearest point (seen) of the line
- oFarPoint
- Returns the farest point (seen) of the line
- iWidth
- Wight of the window (in pixel)
- iHeight
- Height of the window (in pixel)
- mmInSupportUnit
- Inverse of the size(height) of a pixel in millimeter
- ratioWH
- Ratio Height of a pixel / Width of a pixel
o GetBoundingSphere
-
Gets the bounding sphere of all non-furtive representation of the scene.
- Returns:
- CAT3DBoundingSphere
o GetFocusDistance
public virtual inline float GetFocusDistance( | )const |
-
Gets the focus distance.
- Returns:
- The distance from the Eye to the target.
o GetGravityDirection
-
Sets the gravity direction.
- Returns:
- Direction in model coordinates, positive towards the up.
o GetGravityMode
-
Gets the gravity mode .
o GetOrigin
-
Gets viewpoint eye position.
- Returns:
- The Position of the Eye
o GetProjectionType
-
Gets the type of projection on the window.
o GetSightDirection
-
Gets viewpoint sight.
- Returns:
- Sight Direction (Direction where the observator looks at)
o GetTarget
-
Gets the target location.
Role:The target is the point situated a a Focus distance from
the eye of the viewpoint in the sight direction. This point can be also called focal point.
- Returns:
- Target point
o GetUpDirection
-
Gets viewpoint up.
- Returns:
- Up direction (Direction of the observator head's top)
o Is3D
-
Retrieves whether viewpoint is a three dimensional one or not.
- Returns:
- The value is always TRUE.
o Reframe
public virtual void Reframe( | const float | iWidth, |
| const float | iHeight, |
| const float | mmInSupportUnit, |
| const float | ratioWH) |
-
Reframes the model in the window.
- Parameters:
-
- iWidth
- Wight of the window (in pixel)
- iHeight
- Height of the window (in pixel)
- mmInSupportUnit
- Inverse of the size(height) of a pixel in millimeter
- ratioWH
- Ratio Height of a pixel / Width of a pixel
o Reframe
public virtual void Reframe( | const float | iWidth, |
| const float | iHeight, |
| const float | mmInSupportUnit, |
| const float | ratioWH, |
| const CAT3DBoundingSphere& | iBs3D) |
-
Reframes the model in the window.
- Parameters:
-
- iWidth
- Wight of the window (in pixel)
- iHeight
- Height of the window (in pixel)
- mmInSupportUnit
- Inverse of the size(height) of a pixel in millimeter
- ratioWH
- Ratio Height of a pixel / Width of a pixel
- iBs3D
- CAT3DBoundingSphere we want to fit on the specified position
o RemoveFurtiveRep
-
Removes the representation from the furtive list.
- Parameters:
-
- iRep
- Representation 3D
o RemoveRep
-
Removes the representation from the furtive list.
- Parameters:
-
- iRep
- Representation 3D
o Set
-
Sets viewpoint location (main characteristics).
- Parameters:
-
- iEye
- Position of the Eye
- iSight
- Sight Direction (Direction where the observator looks at)
- iUp
- Up direction (Direction of the observator head's top)
o SetFocus
public virtual void SetFocus( | const float& | ) |
-
Sets the focus distance.
- Parameters:
-
- iFocusDistance
- The distance from the Eye to the target
o SetGravityDirection
-
Sets the gravity direction.
- Parameters:
-
- iDirection
- Direction in model coordinates, positive towards the up.
o SetGravityMode
-
Sets the gravity mode .
- Parameters:
-
- iGravityMode
o SetOrigin
-
Sets viewpoint eye position.
- Parameters:
-
- iEye
- Position of the Eye
o SetProjectionType
-
Sets the type of projection.
o SetSightDirection
-
Sets viewpoint sight.
- Parameters:
-
- iSight
- Sight Direction (Direction where the observator looks at)
o SetTarget
-
Sets the Target.
Role:It changes the focus (CONIC proj type) or the origin (CYLINDRIC).
Sight direction stays invariant.
o SetUpDirection
-
Sets viewpoint up.
- Parameters:
-
- iUp
- Up direction (Direction of the observator head's top)
o operator =
-
Copies the geometric definition of a CAT3DViewpoint.
This object is included in the file: CAT3DViewpoint.h
If needed, your Imakefile.mk should include the module: CATViz