Public Member Functions | Static Public Member Functions | List of all members
MultilineBreak Struct Referenceabstract

Stores breaks for a multiline. More...

#include <MultilineHandler.h>

Inheritance diagram for MultilineBreak:
RefCountedBase RefCounted< IRefCounted > IRefCounted

Public Member Functions

DGNPLATFORM_EXPORT
MlineBreakLengthType 
GetLengthType () const
 Get the length flags from the multi-line break. More...
 
DGNPLATFORM_EXPORT void SetLengthType (MlineBreakLengthType type)
 Set the length flags from the multi-line break. More...
 
DGNPLATFORM_EXPORT double GetLength () const
 Get the length from the multi-line break. More...
 
DGNPLATFORM_EXPORT void SetLength (double length)
 Set the length from the multi-line break. More...
 
DGNPLATFORM_EXPORT double GetOffset () const
 Get the offset from the first point in the segment. More...
 
DGNPLATFORM_EXPORT void SetOffset (double offset)
 Get the offset from the first point in the segment. More...
 
DGNPLATFORM_EXPORT UInt32 GetProfileMask () const
 Get the profile mask for the breaks. More...
 
DGNPLATFORM_EXPORT void SetProfileMask (UInt32 lineMask)
 Get the profile mask for the breaks. More...
 
DGNPLATFORM_EXPORT bool ProfileIsMasked (UInt32 profileNum)
 Determine if a given profile is affected by this break. More...
 
- Public Member Functions inherited from RefCounted< IRefCounted >
void * operator new (size_t size)
 
void operator delete (void *rawMemory, size_t size)
 
UInt32 AddRef () const
 
UInt32 Release () const
 
 RefCounted ()
 
 RefCounted (RefCounted const &rhs)
 
RefCountedoperator= (RefCounted const &rhs)
 
UInt32 GetRefCount () const
 

Static Public Member Functions

static DGNPLATFORM_EXPORT
MultilineBreakPtr 
Create (double offset, MlineBreakLengthType lengthType, double length, UInt32 profileMask)
 Create a multi-line break on a specific segment. More...
 

Additional Inherited Members

- Protected Member Functions inherited from RefCounted< IRefCounted >
virtual ~RefCounted ()
 
- Protected Member Functions inherited from IRefCounted
virtual ~IRefCounted ()
 
void * operator new (size_t size)
 
void operator delete (void *rawMemory, size_t size)
 

Detailed Description

Stores breaks for a multiline.

Remarks
Required library : DgnPlatform<ApiNumber>.lib i.e. DgnPlatform5.lib

Member Function Documentation

static DGNPLATFORM_EXPORT MultilineBreakPtr Create ( double  offset,
MlineBreakLengthType  lengthType,
double  length,
UInt32  profileMask 
)
static

Create a multi-line break on a specific segment.

Parameters
[in]offsetThe offset along the segment work line. It will be igored if lengthType is MLBREAK_FROM_JOINT or MLBREAK_BETWEEN_JOINTS.
[in]lengthTypeQualifier for the break length; can specify whether it starts at previous point and/or runs to next point.
[in]lengthThe length of the break; ignored if lengthType is MLBREAK_TO_JOINT or MLBREAK_BETWEEN_JOINTS.
[in]profileMaskA bit mask of profiles to break. Each bit corresponds to the profiles in profile order, not spatial order. Use MLINE_BREAKS_ALLLINES for all lines.
Returns
a MultilinePoint
DGNPLATFORM_EXPORT double GetLength ( ) const

Get the length from the multi-line break.

This value is ignored if the the MlineBreakLengthType is MLBREAK_TO_JOINT or MLBREAK_BETWEEN_JOINTS.

Returns
The length of the break
DGNPLATFORM_EXPORT MlineBreakLengthType GetLengthType ( ) const

Get the length flags from the multi-line break.

This flag determines whether the break extends from one or both of the points, or just has a fixed length.

Returns
The current type
DGNPLATFORM_EXPORT double GetOffset ( ) const

Get the offset from the first point in the segment.

The offset is always along the workline, regardless of angle. This value is ignored if the the MlineBreakLengthType is MLBREAK_FROM_JOINT or MLBREAK_BETWEEN_JOINTS.

Returns
The offset along the segment of the break
DGNPLATFORM_EXPORT UInt32 GetProfileMask ( ) const

Get the profile mask for the breaks.

Each bit represents a profile. Bits are in profile order, not in any spatial order.

Returns
The profile mask of the break
DGNPLATFORM_EXPORT bool ProfileIsMasked ( UInt32  profileNum)

Determine if a given profile is affected by this break.

This is just a convenience routine that does the bit comparisons. Profiles are 0-based.

Parameters
[in]profileNumProfile to test.
DGNPLATFORM_EXPORT void SetLength ( double  length)

Set the length from the multi-line break.

This value is ignored if the the MlineBreakLengthType is MLBREAK_TO_JOINT or MLBREAK_BETWEEN_JOINTS.

Parameters
[in]lengthThe new length of the break.
DGNPLATFORM_EXPORT void SetLengthType ( MlineBreakLengthType  type)

Set the length flags from the multi-line break.

This flag determines whether the break extends from one or both of the points, or just has a fixed length.

Parameters
[in]typeThe new type.
DGNPLATFORM_EXPORT void SetOffset ( double  offset)

Get the offset from the first point in the segment.

The offset is always along the workline, regardless of angle. This value is ignored if the the MlineBreakLengthType is MLBREAK_FROM_JOINT or MLBREAK_BETWEEN_JOINTS.

Parameters
[in]offsetThe new offset for the break.
DGNPLATFORM_EXPORT void SetProfileMask ( UInt32  lineMask)

Get the profile mask for the breaks.

Each bit represents a profile. Bits are in profile order, not in any spatial order.

Parameters
[in]lineMaskThe new mask for the break.

The documentation for this struct was generated from the following file:

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.