Visual3D Game Engine API Documentation for XNA, C#, VB, and .NET

Namespace: Visual3D
Assembly: Visual3D (in Visual3D.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax


	C#			Visual Basic

[SerializableAttribute]
public class AssetFile : Asset, INamed, 
	IHasDescription

<SerializableAttribute> _
Public Class AssetFile _
	Inherits Asset _
	Implements INamed, IHasDescription

Members

All Members

Constructors Public method

Fields

Properties Public property

Methods

Events

 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

	Member	Description
	AssetFile(String, FileFolder, Int64, DateTime)	Initializes a new instance of the AssetFile class
	AccessCount
	AssetID	(Inherited from Registered.)
	AssetInfo	(Inherited from Registered.)
	AssetOwner	Gets or sets the owner to which this asset belongs and is a member of.
	AttachedToOwner(IComponentOwner)	(Inherited from EntityComponent.)
	BaseAsset	(Inherited from Registered.)
	CheckExists()()()()
	ComponentOwner	Owner of this component (contained in it's ".Components" container). (Inherited from EntityComponent.)
	Components	Components that are attached to this Entity. (Inherited from ComponentBase.)
	ComponentsForGlobalSceneFolders	(Inherited from ComponentBase.)
	Context	Defines the Owner of this component as well as the role (i.e. 'slot') that this component fulfills. (Inherited from ComponentBase.)
	CreateDisconnectedSource(String)
	CreateIdentity()()()()	(Inherited from Registered.)
	CreateIdentityList()()()()	(Inherited from Registered.)
	CreateInstance(Boolean)	Creates an instance or non-inheriting duplicate of this asset.
	CreateService<(Of <<'(TService>)>>)()()()()	(Inherited from ComponentBase.)
	DefaultCompressionLevel	The compression level, from 0 (largest file, but fastest) to 9 (smallest file, slowest).
	DetachedFromOwner(IComponentOwner)	(Inherited from EntityComponent.)
	Dispose()()()()	(Inherited from ComponentBase.)
	Disposed	(Inherited from ComponentBase.)
	Exists
	FileExtension	Contains file extension converted to lowercase
	FileWriteTime
	Folder
	FolderName
	FullName
	FullNameChanged
	FullPath
	GetAbsolutePath()()()()
	GetAppendingOutputStream()()()()	Gets a stream for appending to an existing file.
	GetAssetFullName()()()()	Returns FullPath if it starts with any project path allowed showing project folder. Otherwise returns FullName.
	GetCompressedInputStream()()()()
	GetCompressedInputStream(Stream, String)
	GetCompressedOutputStream()()()()
	GetCompressedOutputStream(String)
	GetCompressedOutputStream(Stream, String, Int32)
	GetCompressedStream(Stream, Boolean, String, Int32)
	GetDescription()()()()
	GetDuplicates()()()()
	GetEncryptedInputStream(Stream)
	GetEncryptedOutputStream(Stream)
	GetEncryptedStream(Stream, Boolean)
	GetEncryptedStream(Stream, Boolean, array<Byte>[]()[][], array<Byte>[]()[][], Boolean)
	GetFileStream(String, Stream%, FileMode, FileAccess, FileShare, Boolean)
	GetInputFileStream(AssetFile)
	GetInputFileStream(String, Stream%)
	GetInputStream(Stream%)
	GetInputStream(String)
	GetInputStream(String, Boolean)
	GetLoader()()()()
	GetNewest(IEnumerable<(Of <<'(AssetFile>)>>))
	GetOutputFileStream(String)
	GetOutputFileStream(String, FileMode)
	GetOutputFileStream(String, Stream%)
	GetOutputFileStream(String, Stream%, FileMode)
	GetOutputStream()()()()	Gets a stream for creating a new file or overwriting an existing one.
	GetOutputStream(FileMode)	Gets a stream for writing to a file.
	GetOutputStream(Stream%)	Gets a stream for writing to a file.
	GetOutputStream(Stream%, FileMode)	Gets a stream for writing to a file.
	GetOutputStream(String, Boolean, Int32)
	GetService<(Of <<'(TService>)>>)()()()()	(Inherited from ComponentBase.)
	GetService<(Of <<'(TService>)>>)(TService%)	(Inherited from ComponentBase.)
	GetStream()()()()
	GetText()()()()
	GetText(Encoding)
	GetTextASCII()()()()
	GetTextLines()()()()
	GetTextLines(Encoding)	Gets a list with a string for each line of text, or an empty list if the file is empty or an exception occured.
	GetTextReader()()()()
	GetTextReader(Encoding)
	GetUpdatedLength()()()()
	Handle
	Handle	(Inherited from Registered.)
	HasComponents	(Inherited from ComponentBase.)
	HasHandle	(Inherited from Registered.)
	HasName	(Inherited from EntityComponent.)
	HasPrototype	Gets if a prototype has been specified to inherit instance data from.
	HasScope	(Inherited from Registered.)
	HasUniqueName	Gets if a UniqueName is specified to identify this asset with respect to its owner's other members. (Inherited from Registered.)
	ID	(Inherited from Registered.)
	IDChanged	(Inherited from Registered.)
	ImplicitWideningImplicitImplicitImplicit(String to AssetFile)
	ImplicitWideningImplicitImplicitImplicit(AssetFile to String)
	Initialize()()()()	Initializes the asset so that it might be prepared for use. By default, PrepareForUse() is called from this method as well.
	IsAccessed
	IsDeserialized	Indicates if Instance was created by Deserialization. (Inherited from ComponentBase.)
	IsDisposed	Indicates if resource has been disposed.
	IsDisposing	Indicates if resource is in process of Disposing but not fully disposed.
	IsDuplicate	Indicates if this Asset File is considered a "Duplicate" which means that it will not be returned by the Asset Manager for this FullName (but rather another asset file will be returned instead).
	IsIgnored
	IsInitialized	Gets if this entity is currently in an initialized (and non-disposed) state.
	IsNullOrEmpty(AssetFile)
	IsNullOrNotExists(AssetFile)
	IsPrototype
	IsReadyForUse	Gets/sets if asset is ready to be used. Can be set to 'true' in class constructor in order to skip Preparation logic.
	IsSaved	Indicates if the component is to be Saved when the owning context is saved (e.g. for components in your scene, this controls whether or not they are saved to the scene file when the scene is saved). Typically objects are 'Saved', unless they are transient to be programmatically created each time. (Inherited from ComponentBase.)
	IsSavedOnCreatingInstance
	Length
	Load<(Of <<'(TAsset>)>>)()()()()
	Load<(Of <<'(TAsset>)>>)(String)
	Load<(Of <<'(TAsset>)>>)(Boolean, String)
	LoadAsset()()()()
	LoadedAsset
	LoadFromXml<(Of <<'(TAsset>)>>)()()()()
	LoadObject<(Of <<'(TObject>)>>)(String)
	LoadObject<(Of <<'(TObject>)>>)(Stream, Boolean)
	LoadObject<(Of <<'(TObject>)>>)(String, String)
	LoadObject<(Of <<'(TObject>)>>)(Stream, Boolean, String)
	LoadObject<(Of <<'(TObject>)>>)(String, Boolean, String)
	LoadObject<(Of <<'(TObject>)>>)(Stream, Boolean, Boolean, String)
	LoadObjectFromXml<(Of <<'(TObject>)>>)(String)
	LoadObjectFromXml<(Of <<'(TObject>)>>)(Stream, Boolean)
	LoadObjectUncompressed<(Of <<'(TObject>)>>)(Stream)
	LoadObjectUncompressed<(Of <<'(TObject>)>>)(String)
	LoadUncompressed<(Of <<'(TAsset>)>>)()()()()
	MaximumCompressionLevel
	Name
	NameID	(Inherited from EntityComponent.)
	NoneCompressionLevel
	OnMemberwiseClone()()()()	(Inherited from ComponentBase.)
	OwnerActivated(IComponentOwner)	(Inherited from EntityComponent.)
	OwnerDeactivated(IComponentOwner)	(Inherited from EntityComponent.)
	OwnerOf<(Of <<'(TOwner>)>>)()()()()	(Inherited from Registered.)
	PathDelimiter
	PrepareForUse()()()()	Attempts to prepare asset for use. To be sure, check "IsReadyForUse" after calling this method to ensure it's really ready for use before using it.
	Prototype	Gets or sets the prototype, if specified, from which this asset inherits instance data.
	Save(Object)
	Save(Object, String)
	Save(Object, Boolean, String)
	SaveObject(Object, String)
	SaveObject(Object, Stream, Boolean)
	SaveObject(Object, String, String)
	SaveObject(Object, Stream, Boolean, String)
	SaveObject(Object, String, Boolean, String)
	SaveObject(Object, Stream, Boolean, Boolean, String)
	SaveObjectToBuffer(Object)
	SaveObjectToBuffer(Object, String)
	SaveObjectToBuffer(Object, Boolean, String)
	SaveObjectToBufferUncompressed(Object)
	SaveObjectToMemoryStream(Object)
	SaveObjectToMemoryStream(Object, String)
	SaveObjectToMemoryStream(Object, Boolean, String)
	SaveObjectToMemoryStreamUncompressed(Object)
	SaveObjectToXml(Object, String)
	SaveObjectToXml(Object, Stream, Boolean)
	SaveObjectUncompressed(Object, String)
	SaveObjectUncompressed(Object, Stream, Boolean)
	SaveToXml(Object)
	Scope	(Inherited from Registered.)
	SetLastWriteTime(DateTime)
	SetLastWriteTime(DateTime, Boolean)
	SourceFile	Gets/Sets the source file for this program.
	StorageModule	(Inherited from Registered.)
	ToString()()()()	(Overrides ComponentBase..::..ToString()()()().)
	TryDelete()()()()
	TryToFind(Boolean, Boolean, String, Boolean%, AssetFile)	Tries to find file by full path and if not found - by name. Returns true if any file is found, false otherwise
	UniqueName	(Inherited from Registered.)
	UpdateFromFile()()()()
	WasDuplicateFound	Indicates is a duplicate Asset File was found in the search path. If so, call "GetDuplicates()" to see them.

Inheritance Hierarchy

System..::..Object
  Visual3D.EntityModel..::..ComponentBase
    Visual3D.EntityModel..::..EntityComponent
      Visual3D..::..Registered
        Visual3D..::..Asset
          Visual3D..::..AssetFile
            Visual3D.Graphics3D..::..TextureAssetFile

Syntax

Members

Inheritance Hierarchy

See Also