Previous  Up  

Module OsgText.Text


module Text: sig .. end
Text.
type t
osgText::Text holder.
val create' : unit -> t
val to_drawable : t -> Osg.Drawable.t
val set_text : t -> OsgText.String.t -> unit
val set_font : t -> OsgText.Font.t -> unit
val set_text_direct' : t -> OsgText.String.encoding -> string -> unit
val set_text_direct : ?encoding:OsgText.String.encoding -> t -> string -> unit
Same as OsgText.Text.set_text but doesn't create immediate osgText::String
val set_character_size : t -> float -> aspect_ratio:float -> unit
Set the rendered character size in object coordinates.

type character_size_mode =
| OBJECT_COORDS (*default*)
| SCREEN_COORDS (*internally scale the characters to be constant screen size.*)
| OBJECT_COORDS_WITH_MAXIMUM_SCREEN_SIZE_CAPPED_BY_FONT_HEIGHT (*text that behavaves like OBJECT_COORDS sized text when a long distance way, but has its screen sized capped automatically when the viewer gets near.*) 
val set_character_size_mode : t -> character_size_mode -> unit
Set how the CharacterSize value relates to the final rendered character.
val set_font_resolution : t -> width:int -> height:int -> unit
Set the OsgText.Font reference width and height resolution in texels.
val set_line_spacing : t -> float -> unit
Set the line spacing of the text box, given as a percentage of the character height.

type alignment =
| LEFT_TOP
| LEFT_CENTER
| LEFT_BOTTOM
| CENTER_TOP
| CENTER_CENTER
| CENTER_BOTTOM
| RIGHT_TOP
| RIGHT_CENTER
| RIGHT_BOTTOM
| LEFT_BASE_LINE
| CENTER_BASE_LINE
| RIGHT_BASE_LINE
| LEFT_BOTTOM_BASE_LINE
| CENTER_BOTTOM_BASE_LINE
| RIGHT_BOTTOM_BASE_LINE
| BASE_LINE 
val set_alignment : t -> alignment -> unit

type axis_alignment =
| XY_PLANE
| REVERSED_XY_PLANE
| XZ_PLANE
| REVERSED_XZ_PLANE
| YZ_PLANE
| REVERSED_YZ_PLANE
| SCREEN
| USER_DEFINED_ROTATION 
val set_axis_alignment : t -> axis_alignment -> unit
val set_color : t -> Osg.Vec4.t -> unit

type backdrop_type =
| DROP_SHADOW_BOTTOM_RIGHT
| DROP_SHADOW_CENTER_RIGHT
| DROP_SHADOW_TOP_RIGHT
| DROP_SHADOW_BOTTOM_CENTER
| DROP_SHADOW_TOP_CENTER
| DROP_SHADOW_BOTTOM_LEFT
| DROP_SHADOW_CENTER_LEFT
| DROP_SHADOW_TOP_LEFT
| OUTLINE
| NONE 
val set_backdrop_type : t -> backdrop_type -> unit
val set_backdrop_offset : t -> horizontal:float -> vertical:float -> unit
Default: 0.07
val set_backdrop_color : t -> Osg.Vec4.t -> unit
val set_position : t -> Osg.Vec3.t -> unit
val set_rotation : t -> Osg.Quat.t -> unit
val create : ?encoding:OsgText.String.encoding ->
       ?text:string ->
       ?font:OsgText.Font.t ->
       ?character_size:float ->
       ?aspect_ratio:float ->
       ?character_size_mode:character_size_mode ->
       ?font_resolution:int * int ->
       ?line_spacing:float ->
       ?alignment:alignment ->
       ?axis_alignment:axis_alignment ->
       ?color:Osg.Vec4.t ->
       ?backdrop_type:backdrop_type ->
       ?backdrop_offset:float * float ->
       ?backdrop_color:Osg.Vec4.t ->
       ?position:Osg.Vec3.t -> ?rotation:Osg.Quat.t -> unit -> Osg.Drawable.t
val labl_create : ?encoding:OsgText.String.encoding ->
       ?text:string ->
       ?font:OsgText.Font.t ->
       ?character_size:float ->
       ?aspect_ratio:float ->
       ?character_size_mode:character_size_mode ->
       ?font_resolution:int * int ->
       ?line_spacing:float ->
       ?alignment:alignment ->
       ?axis_alignment:axis_alignment ->
       ?color:Osg.Vec4.t ->
       ?backdrop_type:backdrop_type ->
       ?backdrop_offset:float * float ->
       ?backdrop_color:Osg.Vec4.t ->
       ?position:Osg.Vec3.t -> ?rotation:Osg.Quat.t -> unit -> t