C3D Toolkit  Kernel - 106477, Vision - 190409.106477

Класс GeomFTTextObject генерирует строку текста для вывода ее на экран. Подробнее...

#include <vsn_textsamples.h>

+ Граф наследования:GeomFTTextObject:
+ Граф связей класса GeomFTTextObject:

Открытые члены

 GeomFTTextObject (const char *fontFilePath, Node *pParent=nullptr)
 Специальный конструктор для чтения шрифта из файла. Подробнее...
 
 GeomFTTextObject (const unsigned char *pBufferBytes, size_t bufferSizeInBytes, Node *pParent=nullptr)
 Конструктор по умолчанию. Подробнее...
 
virtual ~GeomFTTextObject ()
 Деструктор.
 
std::wstring GetText () const
 Вернуть текст.
 
void SetText (const std::wstring &text)
 Установить текст.
 
Color GetColorText () const
 Вернуть цвет текста.
 
void SetColorText (const Color &clrText)
 Установить цвет текста.
 
float GetLineLength () const
 Вернуть максимальную длину строки для форматированного текста. Подробнее...
 
void SetLineLength (float lineLength)
 Максимальная длина строки для форматированного текста. Подробнее...
 
uint GetFaceSize () const
 Вернуть текущий размер шрифта в точках(1/72 дюйма). Подробнее...
 
bool SetFaceSize (uint size, uint res=72)
 Установить размер символа для текущего шрифта. Подробнее...
 
MbCube GetFormattedBoundingBox (const wchar_t *string, int len=-1, MbCartPoint3D position=MbCartPoint3D()) const
 Вернуть ограничивающий прямоугольник отформатированной строки. Подробнее...
 
MbCube GetBoundingBox (const wchar_t *string, int len=-1, MbCartPoint3D position=MbCartPoint3D(), MbCartPoint3D spacing=MbCartPoint3D()) const
 Вернуть ограничивающий прямоугольник строки. Подробнее...
 
MbCube GetBoxCharacter ()
 Вернуть ограничивающий прямоугольник для символа. Подробнее...
 
void SetPosition (const MbCartPoint3D &val)
 Установило положение. Подробнее...
 
const MbCartPoint3DGetPosition () const
 Вернуть положение. Подробнее...
 
void SetBoxLineSpacing (double v)
 Установить отступы для ограничевающего прямоугольника. Подробнее...
 
virtual const MbCubeGetBoundingBox ()
 Выдать габаритный куб.
 
bool isEmpty () const
 Является ли объект пустым.
 
void Clear ()
 Очистить содержимое и сделать его пустым.
 
- Открытые члены унаследованные от WireframeGeometry
 WireframeGeometry (Node *pParent=nullptr)
 Конструктор.
 
virtual ~WireframeGeometry ()
 Деструктор.
 
bool IsValid () const
 Действительна ли геометрия.
 
bool HasMaterial () const
 Задан ли материал.
 
MaterialGetHeadMaterial () const
 Получить первый материал из таблицы.
 
size_t GetMaterialCount () const
 Получить число материалов из таблицы.
 
MaterialGetMaterialById (NodeKey id) const
 Получить указатель, соответствующий идентификатору.
 
std::set< Material * > GetMaterialSet () const
 Получить таблицу материалов.
 
std::list< NodeKeyGetMaterialIds () const
 Получить список идентификаторов материалов.
 
bool HasMaterialById (NodeKey id) const
 Существует ли в таблице материал с заданным идентификатором.
 
const MbCubeGetWireBoundingBox ()
 Получить габаритный куб каркаса.
 
bool IsBoundingBoxValid () const
 Является ли габаритный куб допустимым.
 
bool IsTransparent () const
 Прозрачна ли геометрия.
 
bool IsExistTransparentMaterials () const
 Имеется ли прозрачный материал в таблице.
 
bool IsColorEachVertex () const
 Задан ли цвет каждой вершины.
 
void SetColorEachVertex (bool bColorEachVertex)
 Установить флаг назначения цвета для каждой вершины.
 
bool IsWireframe () const
 Является ли геометрия каркасной.
 
virtual size_t GetFaceCount (size_t indexLod=0) const
 Получить число граней.
 
virtual size_t GetVertexCount () const
 Получить число вершин.
 
double GetLineWidth () const
 Получить толщину линии(перегружены для удобства).
 
void SetLineWidth (double lineWidth)
 Задать толщину линии(перегружены для удобства).
 
Color GetWireframeColor () const
 Получить цвет каркаса(перегружены для удобства).
 
void SetWireframeColor (const Color &color)
 Задать цвет каркаса(перегружены для удобства).
 
Pen GetPen () const
 Получить перо.
 
void SetPen (const Pen &pen)
 Задать перо.
 
bool IsWireframeEmpty () const
 Получить кисть. Подробнее...
 
std::vector< float > GetWireFrameVertexPositions () const
 Получить позиции вершин.
 
int GetPolylineCount () const
 Получить число полилиний.
 
uint GetPolylineOffset (int index) const
 Получить смещение полилинии с заданным индексом в контейнере.
 
int GetPolylineSize (int index) const
 Получить размер полилинии с данным индексом.
 
virtual double GetVolume ()
 Получить объем геометрии.
 
bool IsUsedVertexBuffer () const
 Используется ли вершинный буфер.
 
virtual bool IsIgnorePixelCulling () const
 Нужно ли учитывать геометрию в механизме PixelCulling.
 
virtual void IgnorePixelCulling (bool value)
 Запретить PixelCulling для этой геометрии.
 
virtual void TransformVerticesByMatrix (const MbMatrix3D &matrix)
 Преобразовать вершины сетки по матрице.
 
virtual void ReplaceMainMaterial (Material *)
 Заменить основной материал.
 
void AddMaterial (Material *pMaterial)
 Добавить материал в таблицу.
 
virtual void UpdateTransparentMaterialCount () override
 Обновить число прозрачных материалов после операций с таблицей.
 
virtual void InvertNormals ()
 Инвертировать направление всех нормалей.
 
virtual void SetLevelDetail (int value)
 \ ru Задать уровень детализации в диапазоне от 0 до 100.
 
uint AddPoligonGroup (const std::vector< float > &vector)
 Добавить группу вершин и вернуть её идентификатор.
 
uint AddPoligonQuadrangleGroup (const std::vector< float > &vector)
 Добавить группу вершин четырехугольной сетки и вернуть её идентификатор.
 
void SetUseGlobalIdentifier (int global)
 Задать, будет ли использоваться глобальный идентификатор.
 
virtual void CopyVertexBufferToClientSide ()
 Скопировать буфер вершин в память.
 
virtual void ReleaseVertexBufferClientSide (bool update=false)
 Создать буфер вершин.
 
virtual void SetUseVertexBufferObjects (bool usage)
 Задать, будет ли использоваться буфер вершин.
 
virtual void DoRender (const RenderState &)
 Выполнить отрисовку.
 
- Открытые члены унаследованные от Geometry
 Geometry (Node *pParent=nullptr)
 Конструктор по умолчанию.
 
 Geometry (NodeKey id, const String &name)
 Конструктор.
 
virtual ~Geometry ()
 Деструктор.
 
std::vector< GeometryTraits * > GetGeometryTraits () const
 Вернуть список данных геометрии из этого объекта.
 
void AddGeometryTraits (GeometryTraits *pTraits)
 Добавить группу данных о геометрическом теле.
 
void RemoveGeometryTraits (GeometryTraits *pTraits)
 Удалить группу данных о геометрическом теле.
 
virtual bool IsAnnotation () const
 Проверить является ли геометрия аннатационным.
 
virtual void UpdateGeometry ()
 Обновить геометрию по новым данным.
 
- Открытые члены унаследованные от Node
 Node (Node *pParent=nullptr)
 Конструктор по умолчанию.
 
 Node (const String &name)
 Конструктор по умолчанию.
 
 Node (NodeKey key, const String &name=String())
 Конструктор.
 
NodeKey GetUniqueKey () const
 Вернуть ключ, идентифицирующий экземпляр Node.
 
void SetUniqueKey (NodeKey key)
 Установить уникальный ключ для этого экземпляра.
 
NodeKey GetCustomKey () const
 Вернуть пользовательский ключ, идентифицирующий экземпляр Node.
 
void SetCustomKey (NodeKey key)
 Установить пользовательский уникальный ключ для этого экземпляра.
 
NodeGetParentNode () const
 Вернуть указатель на родительский объект или NULL, если родителя нет.
 
void SetParent (Node *pParent)
 Установить родительский объект для этого объекта.
 
bool IsNotificationsBlocked () const
 Вернуть True, если уведомления заблокированы, в противном случае False.
 
bool SetBlockNotifications (bool block)
 Установить блокировку уведомлений и вернуть предыдущее значение блокировки.
 
Nodeoperator= (const Node &other)
 Оператор присваивания.
 
- Открытые члены унаследованные от Object
 Object (const String &name=String())
 Конструктор по умолчанию.
 
 Object (Object *pParent)
 Конструктор c родителем.
 
virtual ~Object ()
 Деструктор.
 
void SetParent (Object *pParent)
 Установить родителя для объекта.
 
MutexGetMutex ()
 Мьютекс объекта.
 
String GetObjectName () const
 Получить имя объекта.
 
void SetObjectName (const String &name)
 Установить имя объекту.
 
bool IsControlType () const
 Вернуть тип объекта.
 
ObjectGetParent () const
 Вернуть указатель на родителя.
 
Variant GetProperty (const char *name) const
 Вернуть вариант свойства по имени.
 
bool IsSignalsBlocked () const
 Вернуть признак блокировки сигналов этого объекта.
 
void AddEventListener (Object *obj)
 Добавить слушателя событий.
 
void RemoveEventListener (Object *obj)
 Удалить слушателя событий.
 
ObjectGetSender () const
 Вернуть указатель на объект, который с генерировал сигнал.
 
Thread * GetThread () const
 NO TRANSLATION.
 
void BindWithThread (Thread *thread)
 Связывание c потоком.
 
int StartTimer (int interval, TimerType timerType=tt_CoarseTimer)
 NO TRANSLATION.
 
void KillTimer (int id)
 NO TRANSLATION.
 
const std::vector< Object * > & GetChildren () const
 Вернуть список указателей детей.
 
Objectoperator= (const Object &)
 Оператор присваивания.
 
- Открытые члены унаследованные от BasicObject
 BasicObject ()
 Конструктор по умолчанию.
 
virtual ~BasicObject ()
 Деструктор.
 

Защищенные члены

virtual void OpenGLDraw (const RenderState &state) override
 Оператор копирования. Подробнее...
 
- Защищенные члены унаследованные от WireframeGeometry
virtual void OGLInitGeom (const RenderState &)
 Выполнить отрисовку.
 
void ClearWireframe ()
 Очистить всю каркасную геометрию.
 
 WireframeGeometry (WireframeGeometryPrivate &dd, Node *pParent)
 Конструктор для внутреннего использования.
 
- Защищенные члены унаследованные от Geometry
 Geometry (GeometryPrivate &dd, Node *pParent)
 Конструктор для внутреннего использования.
 
- Защищенные члены унаследованные от Node
 Node (NodePrivate &dd, Node *pParent)
 Конструктор для внутреннего использования.
 
virtual ~Node ()
 Деструктор.
 
virtual void SceneModificationEvent (const std::shared_ptr< SceneModification > &modification)
 Эта функция вызывается, если произошли какие-либо изменения в сцене.
 

Подробное описание

Класс GeomFTTextObject генерирует строку текста для вывода ее на экран.

Конструктор(ы)

◆ GeomFTTextObject() [1/2]

GeomFTTextObject::GeomFTTextObject ( const char *  fontFilePath,
Node pParent = nullptr 
)

Специальный конструктор для чтения шрифта из файла.

Специальный конструктор необходим для чтения шрифта из файла, а также установки флага ошибки.

Аргументы
[in]fontFilePath- Путь к файлу шрифта.
[in]pParent- Указатель на родительский объект.

◆ GeomFTTextObject() [2/2]

GeomFTTextObject::GeomFTTextObject ( const unsigned char *  pBufferBytes,
size_t  bufferSizeInBytes,
Node pParent = nullptr 
)

Конструктор по умолчанию.

Специальный конструктор для чтения шрифта из буфера памяти.

Специальный конструктор необходим для чтения шрифта из буфера памяти, а также установки флага ошибки. Буфер принадлежит пользователю и не копируется. Указатель должен быть действителен для использования.

Аргументы
[in]pBufferBytes- Указатель на буфер данных.
[in]bufferSizeInBytes- Длина буфера в байтах.
[in]pParent- Указатель на родительский объект.

Методы

◆ GetLineLength()

float GeomFTTextObject::GetLineLength ( ) const

Вернуть максимальную длину строки для форматированного текста.

Возвращает
Текущая длина строки.

◆ SetLineLength()

void GeomFTTextObject::SetLineLength ( float  lineLength)

Максимальная длина строки для форматированного текста.

Аргументы
[in]lineLength- Новая длина строки.

◆ GetFaceSize()

uint GeomFTTextObject::GetFaceSize ( ) const

Вернуть текущий размер шрифта в точках(1/72 дюйма).

Возвращает
Размер шрифта.

◆ SetFaceSize()

bool GeomFTTextObject::SetFaceSize ( uint  size,
uint  res = 72 
)

Установить размер символа для текущего шрифта.

Аргументы
[in]size- Размер шрифта в точках (1/72 дюйма).
[in]res- Разрешение устройства.
Возвращает
True, если размер установлен корректно.

◆ GetFormattedBoundingBox()

MbCube GeomFTTextObject::GetFormattedBoundingBox ( const wchar_t *  string,
int  len = -1,
MbCartPoint3D  position = MbCartPoint3D() 
) const

Вернуть ограничивающий прямоугольник отформатированной строки.

Аргументы
[in]string- Строка.
[in]len- Длина строки.
[in]position- Позиция пера для первого символа.
Возвращает
Соответствующий ограничивающий прямоугольник.

◆ GetBoundingBox()

MbCube GeomFTTextObject::GetBoundingBox ( const wchar_t *  string,
int  len = -1,
MbCartPoint3D  position = MbCartPoint3D(),
MbCartPoint3D  spacing = MbCartPoint3D() 
) const

Вернуть ограничивающий прямоугольник строки.

Аргументы
[in]string- Строка.
[in]len- Длина строки.
[in]position- Позиция пера для первого символа.
[in]spacing- Вектор смещения для каждого символа.
Возвращает
Соответствующий ограничивающий прямоугольник.

◆ GetBoxCharacter()

MbCube GeomFTTextObject::GetBoxCharacter ( )

Вернуть ограничивающий прямоугольник для символа.

Возвращает
Соответствующий ограничивающий прямоугольник.

◆ SetPosition()

void GeomFTTextObject::SetPosition ( const MbCartPoint3D val)

Установило положение.

Аргументы
[in]val- положение.

◆ GetPosition()

const MbCartPoint3D& GeomFTTextObject::GetPosition ( ) const

Вернуть положение.

Возвращает
Положение

◆ SetBoxLineSpacing()

void GeomFTTextObject::SetBoxLineSpacing ( double  v)

Установить отступы для ограничевающего прямоугольника.

Аргументы
[in]v- значение оступа.

◆ OpenGLDraw()

virtual void GeomFTTextObject::OpenGLDraw ( const RenderState state)
overrideprotectedvirtual

Оператор копирования.

Отрисовать текст.

Замещает WireframeGeometry.


Объявления и описания членов класса находятся в файле: